1 |
|
2 | import {AWSError} from './error';
|
3 | /**
|
4 | * Represents a metadata service available on EC2 instances. Using the request() method, you can receieve metadata about any available resource on the metadata service.
|
5 | */
|
6 | export class MetadataService {
|
7 | /**
|
8 | * Creates a new MetadataService object with a given set of options.
|
9 | */
|
10 | constructor(options?: MetadataServiceOptions);
|
11 | /**
|
12 | * Sends a request to the instance metadata service for a given resource.
|
13 | */
|
14 | request(path: string, callback: (err: AWSError, data: string) => void): void;
|
15 | /**
|
16 | * 169.254.169.254
|
17 | */
|
18 | static host: string
|
19 | /**
|
20 | * A map of options to pass to the underlying HTTP request.
|
21 | */
|
22 | httpOptions: {
|
23 | /**
|
24 | * a timeout value in milliseconds to wait before aborting the connection. Set to 0 for no timeout.
|
25 | */
|
26 | timeout: number;
|
27 | }
|
28 | }
|
29 |
|
30 | interface MetadataServiceOptions {
|
31 | /**
|
32 | * the hostname of the instance metadata service.
|
33 | */
|
34 | host?: string;
|
35 | /**
|
36 | * a map of options to pass to the underlying HTTP request.
|
37 | */
|
38 | httpOptions?: {
|
39 | /**
|
40 | * a timeout value in milliseconds to wait before aborting the connection. Set to 0 for no timeout.
|
41 | */
|
42 | timeout?: number;
|
43 | }
|
44 | /**
|
45 | * the maximum number of retries to perform for timeout errors.
|
46 | */
|
47 | maxRetries?: number;
|
48 | /**
|
49 | * A set of options to configure the retry delay on retryable errors. See AWS.Config for details.
|
50 | */
|
51 | retryDelayOptions?: any
|
52 | } |
\ | No newline at end of file |