@aws-sdk/ec2-metadata-service 3.955.0 → 3.956.0

package/dist-cjs/index.js

@@ -42,6 +42,8 @@ class MetadataService {
     config;
     retries;
     backoffFn;
+    tokenTtl;
+    port;
     constructor(options = {}) {
         this.config = (async () => {
             const profile = options?.profile || process.env.AWS_PROFILE;
@@ -56,6 +58,23 @@ class MetadataService {
         this.disableFetchToken = options?.disableFetchToken || false;
         this.retries = options?.retries ?? 3;
         this.backoffFn = this.createBackoffFunction(options?.backoff);
+        this.tokenTtl = this.validateTokenTtl(options?.tokenTtl ?? 21600);
+        this.port = options?.port;
+    }
+    validateTokenTtl(tokenTtl) {
+        if (!Number.isInteger(tokenTtl) || tokenTtl <= 0) {
+            throw new Error("tokenTtl must be a positive integer");
+        }
+        return tokenTtl;
+    }
+    resolvePort(endpointUrl) {
+        if (this.port !== undefined) {
+            return this.port;
+        }
+        if (endpointUrl.port) {
+            return parseInt(endpointUrl.port);
+        }
+        return undefined;
     }
     createBackoffFunction(backoff) {
         if (typeof backoff === "function") {
@@ -127,7 +146,7 @@ class MetadataService {
                 hostname: endpointUrl.hostname,
                 path: endpointUrl.pathname + path,
                 protocol: endpointUrl.protocol,
-                port: endpointUrl.port ? parseInt(endpointUrl.port) : undefined,
+                port: this.resolvePort(endpointUrl),
             });
             try {
                 const { response } = await handler.handle(request, {});
@@ -164,12 +183,12 @@ class MetadataService {
         const tokenRequest = new protocolHttp.HttpRequest({
             method: "PUT",
             headers: {
-                "x-aws-ec2-metadata-token-ttl-seconds": "21600",
+                "x-aws-ec2-metadata-token-ttl-seconds": String(this.tokenTtl),
             },
             hostname: endpointUrl.hostname,
             path: "/latest/api/token",
             protocol: endpointUrl.protocol,
-            port: endpointUrl.port ? parseInt(endpointUrl.port) : undefined,
+            port: this.resolvePort(endpointUrl),
         });
         try {
             const { response } = await handler.handle(tokenRequest, {});

package/dist-es/MetadataService.js

@@ -8,6 +8,8 @@ export class MetadataService {
     config;
     retries;
     backoffFn;
+    tokenTtl;
+    port;
     constructor(options = {}) {
         this.config = (async () => {
             const profile = options?.profile || process.env.AWS_PROFILE;
@@ -22,6 +24,23 @@ export class MetadataService {
         this.disableFetchToken = options?.disableFetchToken || false;
         this.retries = options?.retries ?? 3;
         this.backoffFn = this.createBackoffFunction(options?.backoff);
+        this.tokenTtl = this.validateTokenTtl(options?.tokenTtl ?? 21600);
+        this.port = options?.port;
+    }
+    validateTokenTtl(tokenTtl) {
+        if (!Number.isInteger(tokenTtl) || tokenTtl <= 0) {
+            throw new Error("tokenTtl must be a positive integer");
+        }
+        return tokenTtl;
+    }
+    resolvePort(endpointUrl) {
+        if (this.port !== undefined) {
+            return this.port;
+        }
+        if (endpointUrl.port) {
+            return parseInt(endpointUrl.port);
+        }
+        return undefined;
     }
     createBackoffFunction(backoff) {
         if (typeof backoff === "function") {
@@ -93,7 +112,7 @@ export class MetadataService {
                 hostname: endpointUrl.hostname,
                 path: endpointUrl.pathname + path,
                 protocol: endpointUrl.protocol,
-                port: endpointUrl.port ? parseInt(endpointUrl.port) : undefined,
+                port: this.resolvePort(endpointUrl),
             });
             try {
                 const { response } = await handler.handle(request, {});
@@ -130,12 +149,12 @@ export class MetadataService {
         const tokenRequest = new HttpRequest({
             method: "PUT",
             headers: {
-                "x-aws-ec2-metadata-token-ttl-seconds": "21600",
+                "x-aws-ec2-metadata-token-ttl-seconds": String(this.tokenTtl),
             },
             hostname: endpointUrl.hostname,
             path: "/latest/api/token",
             protocol: endpointUrl.protocol,
-            port: endpointUrl.port ? parseInt(endpointUrl.port) : undefined,
+            port: this.resolvePort(endpointUrl),
         });
         try {
             const { response } = await handler.handle(tokenRequest, {});

package/dist-types/MetadataService.d.ts

@@ -7,10 +7,14 @@ export declare class MetadataService {
     private config;
     private retries;
     private backoffFn;
+    private tokenTtl;
+    private port?;
     /**
      * Creates a new MetadataService object with a given set of options.
      */
     constructor(options?: MetadataServiceOptions);
+    private validateTokenTtl;
+    private resolvePort;
     private createBackoffFunction;
     private sleep;
     private retryWithBackoff;

package/dist-types/MetadataServiceOptions.d.ts

@@ -37,4 +37,13 @@ export interface MetadataServiceOptions {
      * if the function returns a number, the number will be used as seconds duration to wait before the following retry attempt.
      */
     backoff?: number | ((numFailures: number) => Promise<void> | number);
+    /**
+     * the TTL of the token in seconds, defaulting to 21,600 seconds (6 hours)
+     */
+    tokenTtl?: number;
+    /**
+     * the port for the endpoint. If not specified, uses the default port for the protocol (80 for HTTP, 443 for HTTPS).
+     * can also be provided as a part of the endpoint URL, though an explicit config value will take precedence.
+     */
+    port?: number;
 }

package/dist-types/ts3.4/MetadataService.d.ts

@@ -4,7 +4,11 @@ export declare class MetadataService {
   private config;
   private retries;
   private backoffFn;
+  private tokenTtl;
+  private port?;
   constructor(options?: MetadataServiceOptions);
+  private validateTokenTtl;
+  private resolvePort;
   private createBackoffFunction;
   private sleep;
   private retryWithBackoff;

package/dist-types/ts3.4/MetadataServiceOptions.d.ts

@@ -8,4 +8,6 @@ export interface MetadataServiceOptions {
   disableFetchToken?: boolean;
   retries?: number;
   backoff?: number | ((numFailures: number) => Promise<void> | number);
+  tokenTtl?: number;
+  port?: number;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-sdk/ec2-metadata-service",
-  "version": "3.955.0",
+  "version": "3.956.0",
   "scripts": {
     "build": "concurrently 'yarn:build:types' 'yarn:build:es' && yarn build:cjs",
     "build:cjs": "node ../../scripts/compilation/inline ec2-metadata-service",
@@ -24,16 +24,16 @@
   "module": "./dist-es/index.js",
   "types": "./dist-types/index.d.ts",
   "dependencies": {
-    "@aws-sdk/types": "3.953.0",
-    "@smithy/node-config-provider": "^4.3.6",
-    "@smithy/node-http-handler": "^4.4.6",
-    "@smithy/protocol-http": "^5.3.6",
-    "@smithy/types": "^4.10.0",
-    "@smithy/util-stream": "^4.5.7",
+    "@aws-sdk/types": "3.956.0",
+    "@smithy/node-config-provider": "^4.3.7",
+    "@smithy/node-http-handler": "^4.4.7",
+    "@smithy/protocol-http": "^5.3.7",
+    "@smithy/types": "^4.11.0",
+    "@smithy/util-stream": "^4.5.8",
     "tslib": "^2.6.2"
   },
   "devDependencies": {
-    "@aws-sdk/credential-providers": "3.955.0",
+    "@aws-sdk/credential-providers": "3.956.0",
     "@tsconfig/recommended": "1.0.1",
     "@types/node": "^18.19.69",
     "concurrently": "7.0.0",