AWS cli documentation change
Summary
Updated ASN parameter documentation and added new 'rateLimit' parameter for bandwidth allocation on virtual interfaces
Security assessment
The change adds documentation for the 'rateLimit' parameter which enables bandwidth throttling on virtual interfaces. This is a security feature that helps prevent resource exhaustion attacks by limiting maximum bandwidth usage. However, there's no evidence this addresses an existing vulnerability.
Diff
diff --git a/cli/latest/reference/directconnect/allocate-private-virtual-interface.md b/cli/latest/reference/directconnect/allocate-private-virtual-interface.md index 686b43795..cfa3ce253 100644 --- a//cli/latest/reference/directconnect/allocate-private-virtual-interface.md +++ b//cli/latest/reference/directconnect/allocate-private-virtual-interface.md @@ -15 +15 @@ - * [AWS CLI 2.35.5 Command Reference](../../index.html) » + * [AWS CLI 2.35.8 Command Reference](../../index.html) » @@ -122,5 +122 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/direct ->> ### Note ->> ->> You can use `asnLong` or `asn` , but not both. We recommend using `asnLong` as it supports a greater pool of numbers. ->> ->> * The `asnLong` attribute accepts both ASN and long ASN ranges. +>> * You can use `asnLong` or `asn` , but not both. We recommend using `asnLong` as it supports a greater pool of numbers. @@ -127,0 +124,2 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/direct +>> * If you enter a 4-byte ASN for the `asn` parameter, the API returns an error. +>> * If you are using a 2-byte ASN, the API response will include the 2-byte value for both the `asn` and `asnLong` fields. @@ -137 +135 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/direct ->> ### Note +>> Note the following limitations when using `asnLong` : @@ -139,3 +137,4 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/direct ->> You can use `asnLong` or `asn` , but not both. We recommend using `asnLong` as it supports a greater pool of numbers. ->> ->> * The `asnLong` attribute accepts both ASN and long ASN ranges. +>> * You can use `asnLong` or `asn` , but not both. We recommend using `asnLong` as it supports a greater pool of numbers. +>> * `asnLong` accepts any valid ASN value, regardless if it’s 2-byte or 4-byte. +>> * When using a 4-byte `asnLong` , the API response returns `0` for the legacy `asn` attribute since 4-byte ASN values exceed the maximum supported value of 2,147,483,647. +>> * If you are using a 2-byte ASN, the API response will include the 2-byte value for both the `asn` and `asnLong` fields. @@ -209,0 +209,4 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/direct +> +> rateLimit -> (string) +> +>> The rate limit (bandwidth allocation) to apply to the virtual interface. The rate limit restricts the maximum bandwidth that the virtual interface can use on the parent connection. @@ -214 +217 @@ Shorthand Syntax: - virtualInterfaceName=string,vlan=integer,asn=integer,asnLong=long,mtu=integer,authKey=string,amazonAddress=string,addressFamily=string,customerAddress=string,tags=[{key=string,value=string},{key=string,value=string}] + virtualInterfaceName=string,vlan=integer,asn=integer,asnLong=long,mtu=integer,authKey=string,amazonAddress=string,addressFamily=string,customerAddress=string,tags=[{key=string,value=string},{key=string,value=string}],rateLimit=string @@ -236 +239,2 @@ JSON Syntax: - ] + ], + "rateLimit": "string" @@ -422,5 +426 @@ asn -> (integer) -> ### Note -> -> You can use `asnLong` or `asn` , but not both. We recommend using `asnLong` as it supports a greater pool of numbers. -> -> * The `asnLong` attribute accepts both ASN and long ASN ranges. +> * You can use `asnLong` or `asn` , but not both. We recommend using `asnLong` as it supports a greater pool of numbers. @@ -427,0 +428,2 @@ asn -> (integer) +> * If you enter a 4-byte ASN for the `asn` parameter, the API returns an error. +> * If you are using a 2-byte ASN, the API response will include the 2-byte value for both the `asn` and `asnLong` fields. @@ -435 +437 @@ asnLong -> (long) -> ### Note +> Note the following limitations when using `asnLong` : @@ -437,3 +439,4 @@ asnLong -> (long) -> You can use `asnLong` or `asn` , but not both. We recommend using `asnLong` as it supports a greater pool of numbers. -> -> * The `asnLong` attribute accepts both ASN and long ASN ranges. +> * You can use `asnLong` or `asn` , but not both. We recommend using `asnLong` as it supports a greater pool of numbers. +> * `asnLong` accepts any valid ASN value, regardless if it’s 2-byte or 4-byte. +> * When using a 4-byte `asnLong` , the API response returns `0` for the legacy `asn` attribute since 4-byte ASN values exceed the maximum supported value of 2,147,483,647. +> * If you are using a 2-byte ASN, the API response will include the 2-byte value for both the `asn` and `asnLong` fields. @@ -551,5 +554 @@ bgpPeers -> (list) ->>> ### Note ->>> ->>> You can use `asnLong` or `asn` , but not both. We recommend using `asnLong` as it supports a greater pool of numbers. ->>> ->>> * The `asnLong` attribute accepts both ASN and long ASN ranges. +>>> * You can use `asnLong` or `asn` , but not both. We recommend using `asnLong` as it supports a greater pool of numbers. @@ -556,0 +556,2 @@ bgpPeers -> (list) +>>> * If you enter a 4-byte ASN for the `asn` parameter, the API returns an error. +>>> * If you are using a 2-byte ASN, the API response will include the 2-byte value for both the `asn` and `asnLong` fields. @@ -564 +565 @@ bgpPeers -> (list) ->>> ### Note +>>> Note the following limitations when using `asnLong` : @@ -566,3 +567,4 @@ bgpPeers -> (list) ->>> You can use `asnLong` or `asn` , but not both. We recommend using `asnLong` as it supports a greater pool of numbers. ->>> ->>> * The `asnLong` attribute accepts both ASN and long ASN ranges. +>>> * You can use `asnLong` or `asn` , but not both. We recommend using `asnLong` as it supports a greater pool of numbers. +>>> * `asnLong` accepts any valid ASN value, regardless if it’s 2-byte or 4-byte. +>>> * When using a 4-byte `asnLong` , the API response returns `0` for the legacy `asn` attribute since 4-byte ASN values exceed the maximum supported value of 2,147,483,647. +>>> * If you are using a 2-byte ASN, the API response will include the 2-byte value for both the `asn` and `asnLong` fields. @@ -697,0 +700,4 @@ siteLinkEnabled -> (boolean) +rateLimit -> (string) + +> The rate limit (bandwidth allocation) applied to the virtual interface. The possible values are `50 Mbps` , `100 Mbps` , `200 Mbps` , `300 Mbps` , `400 Mbps` , `500 Mbps` , `1 Gbps` , `2 Gbps` , `5 Gbps` , or `10 Gbps` . + @@ -708 +714 @@ siteLinkEnabled -> (boolean) - * [AWS CLI 2.35.5 Command Reference](../../index.html) » + * [AWS CLI 2.35.8 Command Reference](../../index.html) »