AWS efs documentation change
Summary
Expanded API endpoint documentation with IPv4/IPv6 dual-stack support and FIPS endpoints
Security assessment
The change adds documentation about FIPS-compliant endpoints which are security-enhancing features, but does not indicate remediation of a specific security vulnerability. The update improves security documentation by explaining compliance options.
Diff
diff --git a/efs/latest/ug/api-reference.md b/efs/latest/ug/api-reference.md index de24e70a6..e18c401d8 100644 --- a//efs/latest/ug/api-reference.md +++ b//efs/latest/ug/api-reference.md @@ -5 +5 @@ -API endpointAPI versionRelated topicsWorking with the query API request rate for Amazon EFS +API endpointsAPI versionRelated topicsWorking with the query API request rate for Amazon EFS @@ -23 +23 @@ The operation name also appears in AWS CloudTrail logs for Amazon EFS API calls. -## API endpoint +## API endpoints @@ -25 +25 @@ The operation name also appears in AWS CloudTrail logs for Amazon EFS API calls. -The API endpoint is the DNS name used as a host in the HTTP URI for the API calls. These API endpoints are specific to AWS Regions and take the following form. +An endpoint is a URL that serves as an entry point for an AWS web service. Amazon EFS supports the following endpoint types: @@ -26,0 +27 @@ The API endpoint is the DNS name used as a host in the HTTP URI for the API call + * IPv4 endpoints @@ -28 +29 @@ The API endpoint is the DNS name used as a host in the HTTP URI for the API call - elasticfilesystem.aws-region.amazonaws.com + * Dual-stack (both IPv4 and IPv6) endpoints @@ -30 +31 @@ The API endpoint is the DNS name used as a host in the HTTP URI for the API call -For example, the Amazon EFS API endpoint for the US West (Oregon) Region is the following. + * [FIPS endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#FIPS-endpoints) @@ -33 +33,0 @@ For example, the Amazon EFS API endpoint for the US West (Oregon) Region is the - elasticfilesystem.us-west-2.amazonaws.com @@ -35 +34,0 @@ For example, the Amazon EFS API endpoint for the US West (Oregon) Region is the -For a list of AWS Regions that Amazon EFS supports (where you can create and manage file systems), see [Amazon Elastic File System ](https://docs.aws.amazon.com/general/latest/gr/elasticfilesystem.html#elasticfilesystem-region) in the _AWS General Reference_. @@ -37 +36,48 @@ For a list of AWS Regions that Amazon EFS supports (where you can create and man -The region-specific API endpoint defines the scope of the Amazon EFS resources that are accessible when you make an API call. For example, when you call the `DescribeFileSystems` operation using the preceding endpoint, you get a list of file systems in the US West (Oregon) Region that have been created in your account. +When you make a request, you can specify the endpoint to use. If you do not specify an endpoint, the IPv4 endpoint is used by default. To use a different endpoint type, you must specify it in your request. For examples of how to do this, see Specifying endpoints. For a table of available endpoints, see [Amazon EFS endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/elasticfilesystem.html). + +### IPv4 endpoints + +IPv4 endpoints support IPv4 traffic only. IPv4 endpoints are available for all Regions. The format of the IPv4 endpoint depends on the Region. + + * For IPv4 endpoints in the AWS commercial Regions, the format is `elasticfilesystem.`region`.amazonaws.com`. + +For example, if you specify `elasticfilesystem.us-west-2.amazonaws.com` as the endpoint, we direct your request to the US West (Oregon) Region (us-west-2) endpoint. + + + + + * For IPv4 endpoints in the China Regions, the format is `elasticfilesystem.`region`.amazonaws.com.cn`. + +For example, the Amazon EFS API endpoint for the China (Beijing) Region is `elasticfilesystem.cn-north-1.amazonaws.com.cn`. + + + + +### Dual-stack (IPv4 and IPv6) endpoints + +Dual-stack endpoints support both IPv4 and IPv6 traffic. When you make a request to a dual-stack endpoint, the endpoint URL resolves to an IPv6 or an IPv4 address, depending on the protocol used by your network and client. The format of the dual-stack endpoint depends on the Region. + + * For dual-stack endpoints in the AWS commercial Regions, the format is `efs.`aws-region`.api.aws`. + +For example, the dual-stack endpoint for the US West (Oregon) Region (us-west-2) is `efs.eu-west-2.api.aws`. + + * For dual-stack endpoints in the China Regions, the format is `efs.`region`.api.amazonwebservices.com.cn`. + +For example, the dual-stack endpoint for the China (Beijing) Region is `efs.cn-north-1.api.amazonwebservices.com.cn`. + + + + +### Specifying endpoints + +The following examples show how to specify an endpoint for the US West (N. California) Region (us-west-1) using the AWS CLI for Amazon EFS. + +IPv4 + + + aws efs get-rest-apis --region us-west-1 --endpoint-url https://elasticfilesystem.us-west-1.amazonaws.com + +Dual-stack + + + aws efs get-rest-apis --region us-west-1 --endpoint-url https://efs.us-west-1.api.aws