1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
#ifndef AWS_S3_S3_PLATFORM_INFO_H
#define AWS_S3_S3_PLATFORM_INFO_H
/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#include <aws/s3/s3.h>
struct aws_s3_platform_info_loader;
AWS_EXTERN_C_BEGIN
/**
* Initializes and returns a loader for querying the compute platform for information needed for making configuration
* decisions.
* This will never be NULL.
*/
AWS_S3_API
struct aws_s3_platform_info_loader *aws_s3_platform_info_loader_new(struct aws_allocator *allocator);
AWS_S3_API
struct aws_s3_platform_info_loader *aws_s3_platform_info_loader_acquire(struct aws_s3_platform_info_loader *loader);
AWS_S3_API
struct aws_s3_platform_info_loader *aws_s3_platform_info_loader_release(struct aws_s3_platform_info_loader *loader);
/**
* Retrieves the pre-configured metadata for a given ec2 instance type. If no such pre-configuration exists, returns
* NULL.
*/
AWS_S3_API
const struct aws_s3_platform_info *aws_s3_get_platform_info_for_instance_type(
struct aws_s3_platform_info_loader *loader,
struct aws_byte_cursor instance_type_name);
/**
* Retrieves the metadata for the current environment. If EC2 instance type is unknown, or it is not an EC2 instance at
* all, this value will still include the information about the system that could be determined. This value will never
* be NULL.
* This API is not thread safe.
*/
AWS_S3_API
const struct aws_s3_platform_info *aws_s3_get_platform_info_for_current_environment(
struct aws_s3_platform_info_loader *loader);
/*
* Retrieves a list of EC2 instance types with recommended configuration.
* Returns aws_array_list<aws_byte_cursor>. The caller is responsible for cleaning up the array list.
*/
AWS_S3_API
struct aws_array_list aws_s3_get_recommended_platforms(struct aws_s3_platform_info_loader *loader);
/**
* Returns true if the current process is running on an Amazon EC2 instance powered by Nitro.
*/
AWS_S3_API
bool aws_s3_is_running_on_ec2_nitro(struct aws_s3_platform_info_loader *loader);
/**
* Returns an EC2 instance type assuming this executable is running on Amazon EC2 powered by nitro.
*
* First this function will check it's running on EC2 via. attempting to read DMI info to avoid making IMDS calls.
*
* If the function detects it's on EC2, and it was able to detect the instance type without a call to IMDS
* it will return it.
*
* Finally, it will call IMDS and return the instance type from there.
*
* Note that in the case of the IMDS call, a new client stack is spun up using 1 background thread. The call is made
* synchronously with a 1 second timeout: It's not cheap. To make this easier, the underlying result is cached
* internally and will be freed when aws_s3_library_clean_up() is called.
* @return byte_cursor containing the instance type. If this is empty, the instance type could not be determined.
*/
AWS_S3_API
struct aws_byte_cursor aws_s3_get_ec2_instance_type(struct aws_s3_platform_info_loader *loader);
AWS_EXTERN_C_END
#endif /* AWS_S3_S3_PLATFORM_INFO_H */
|
