@smithy/credential-provider-imds 1.0.1 → 1.0.3

package/dist-types/ts3.4/config/Endpoint.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @internal
+ */
+export declare enum Endpoint {
+    IPv4 = "http://169.254.169.254",
+    IPv6 = "http://[fd00:ec2::254]"
+}

package/dist-types/ts3.4/config/EndpointConfigOptions.d.ts

@@ -0,0 +1,13 @@
+import { LoadedConfigSelectors } from "@smithy/node-config-provider";
+/**
+ * @internal
+ */
+export declare const ENV_ENDPOINT_NAME = "AWS_EC2_METADATA_SERVICE_ENDPOINT";
+/**
+ * @internal
+ */
+export declare const CONFIG_ENDPOINT_NAME = "ec2_metadata_service_endpoint";
+/**
+ * @internal
+ */
+export declare const ENDPOINT_CONFIG_OPTIONS: LoadedConfigSelectors<string | undefined>;

package/dist-types/ts3.4/config/EndpointMode.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @internal
+ */
+export declare enum EndpointMode {
+    IPv4 = "IPv4",
+    IPv6 = "IPv6"
+}

package/dist-types/ts3.4/config/EndpointModeConfigOptions.d.ts

@@ -0,0 +1,13 @@
+import { LoadedConfigSelectors } from "@smithy/node-config-provider";
+/**
+ * @internal
+ */
+export declare const ENV_ENDPOINT_MODE_NAME = "AWS_EC2_METADATA_SERVICE_ENDPOINT_MODE";
+/**
+ * @internal
+ */
+export declare const CONFIG_ENDPOINT_MODE_NAME = "ec2_metadata_service_endpoint_mode";
+/**
+ * @internal
+ */
+export declare const ENDPOINT_MODE_CONFIG_OPTIONS: LoadedConfigSelectors<string | undefined>;

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

@@ -0,0 +1,21 @@
+import { AwsCredentialIdentityProvider } from "@smithy/types";
+import { RemoteProviderInit } from "./remoteProvider/RemoteProviderInit";
+/**
+ * @internal
+ */
+export declare const ENV_CMDS_FULL_URI = "AWS_CONTAINER_CREDENTIALS_FULL_URI";
+/**
+ * @internal
+ */
+export declare const ENV_CMDS_RELATIVE_URI = "AWS_CONTAINER_CREDENTIALS_RELATIVE_URI";
+/**
+ * @internal
+ */
+export declare const ENV_CMDS_AUTH_TOKEN = "AWS_CONTAINER_AUTHORIZATION_TOKEN";
+/**
+ * @internal
+ *
+ * Creates a credential provider that will source credentials from the ECS
+ * Container Metadata Service
+ */
+export declare const fromContainerMetadata: (init?: RemoteProviderInit) => AwsCredentialIdentityProvider;

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

@@ -0,0 +1,10 @@
+import { Provider } from "@smithy/types";
+import { RemoteProviderInit } from "./remoteProvider/RemoteProviderInit";
+import { InstanceMetadataCredentials } from "./types";
+/**
+ * @internal
+ *
+ * Creates a credential provider that will source credentials from the EC2
+ * Instance Metadata Service
+ */
+export declare const fromInstanceMetadata: (init?: RemoteProviderInit) => Provider<InstanceMetadataCredentials>;

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

@@ -0,0 +1,24 @@
+/**
+ * @internal
+ */
+export * from "./fromContainerMetadata";
+/**
+ * @internal
+ */
+export * from "./fromInstanceMetadata";
+/**
+ * @internal
+ */
+export * from "./remoteProvider/RemoteProviderInit";
+/**
+ * @internal
+ */
+export * from "./types";
+/**
+ * @internal
+ */
+export { httpRequest } from "./remoteProvider/httpRequest";
+/**
+ * @internal
+ */
+export { getInstanceMetadataEndpoint } from "./utils/getInstanceMetadataEndpoint";

package/dist-types/ts3.4/remoteProvider/ImdsCredentials.d.ts

@@ -0,0 +1,18 @@
+import { AwsCredentialIdentity } from "@smithy/types";
+/**
+ * @internal
+ */
+export interface ImdsCredentials {
+    AccessKeyId: string;
+    SecretAccessKey: string;
+    Token: string;
+    Expiration: string;
+}
+/**
+ * @internal
+ */
+export declare const isImdsCredentials: (arg: any) => arg is ImdsCredentials;
+/**
+ * @internal
+ */
+export declare const fromImdsCredentials: (creds: ImdsCredentials) => AwsCredentialIdentity;

package/dist-types/ts3.4/remoteProvider/RemoteProviderInit.d.ts

@@ -0,0 +1,32 @@
+import { Logger } from "@smithy/types";
+/**
+ * @internal
+ */
+export declare const DEFAULT_TIMEOUT = 1000;
+/**
+ * @internal
+ */
+export declare const DEFAULT_MAX_RETRIES = 0;
+/**
+ * @internal
+ */
+export interface RemoteProviderConfig {
+    /**
+     * The connection timeout (in milliseconds)
+     */
+    timeout: number;
+    /**
+     * The maximum number of times the HTTP connection should be retried
+     */
+    maxRetries: number;
+}
+/**
+ * @internal
+ */
+export interface RemoteProviderInit extends Partial<RemoteProviderConfig> {
+    logger?: Logger;
+}
+/**
+ * @internal
+ */
+export declare const providerConfigFromInit: ({ maxRetries, timeout, }: RemoteProviderInit) => RemoteProviderConfig;

package/dist-types/ts3.4/remoteProvider/httpRequest.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="node" />
+import { RequestOptions } from "http";
+/**
+ * @internal
+ */
+export declare function httpRequest(options: RequestOptions): Promise<Buffer>;

package/dist-types/ts3.4/remoteProvider/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @internal
+ */
+export * from "./ImdsCredentials";
+/**
+ * @internal
+ */
+export * from "./RemoteProviderInit";

package/dist-types/ts3.4/remoteProvider/retry.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @internal
+ */
+export interface RetryableProvider<T> {
+    (): Promise<T>;
+}
+/**
+ * @internal
+ */
+export declare const retry: <T>(toRetry: RetryableProvider<T>, maxRetries: number) => Promise<T>;

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

@@ -0,0 +1,7 @@
+import { AwsCredentialIdentity } from "@smithy/types";
+/**
+ * @internal
+ */
+export interface InstanceMetadataCredentials extends AwsCredentialIdentity {
+    readonly originalExpiration?: Date;
+}

package/dist-types/ts3.4/utils/getExtendedInstanceMetadataCredentials.d.ts

@@ -0,0 +1,6 @@
+import { Logger } from "@smithy/types";
+import { InstanceMetadataCredentials } from "../types";
+/**
+ * @internal
+ */
+export declare const getExtendedInstanceMetadataCredentials: (credentials: InstanceMetadataCredentials, logger: Logger) => InstanceMetadataCredentials;

package/dist-types/ts3.4/utils/getInstanceMetadataEndpoint.d.ts

@@ -0,0 +1,21 @@
+import { Endpoint } from "@smithy/types";
+/**
+ * Returns the host to use for instance metadata service call.
+ *
+ * The host is read from endpoint which can be set either in
+ * {@link ENV_ENDPOINT_NAME} environment variable or {@link CONFIG_ENDPOINT_NAME}
+ * configuration property.
+ *
+ * If endpoint is not set, then endpoint mode is read either from
+ * {@link ENV_ENDPOINT_MODE_NAME} environment variable or {@link CONFIG_ENDPOINT_MODE_NAME}
+ * configuration property. If endpoint mode is not set, then default endpoint mode
+ * {@link EndpointMode.IPv4} is used.
+ *
+ * If endpoint mode is set to {@link EndpointMode.IPv4}, then the host is {@link Endpoint.IPv4}.
+ * If endpoint mode is set to {@link EndpointMode.IPv6}, then the host is {@link Endpoint.IPv6}.
+ *
+ * @returns Host to use for instance metadata service call.
+ *
+ * @internal
+ */
+export declare const getInstanceMetadataEndpoint: () => Promise<Endpoint>;

package/dist-types/ts3.4/utils/staticStabilityProvider.d.ts

@@ -0,0 +1,16 @@
+import { Logger, Provider } from "@smithy/types";
+import { InstanceMetadataCredentials } from "../types";
+/**
+ * @internal
+ *
+ * IMDS credential supports static stability feature. When used, the expiration
+ * of recently issued credentials is extended. The server side allows using
+ * the recently expired credentials. This mitigates impact when clients using
+ * refreshable credentials are unable to retrieve updates.
+ *
+ * @param provider Credential provider
+ * @returns A credential provider that supports static stability
+ */
+export declare const staticStabilityProvider: (provider: Provider<InstanceMetadataCredentials>, options?: {
+    logger?: Logger | undefined;
+}) => Provider<InstanceMetadataCredentials>;

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@smithy/credential-provider-imds",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "AWS credential provider that sources credentials from the EC2 instance metadata service and ECS container metadata service",
   "main": "./dist-cjs/index.js",
   "module": "./dist-es/index.js",
   "scripts": {
-    "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
+    "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types && yarn build:types:downlevel'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
     "build:es": "tsc -p tsconfig.es.json",
     "build:types": "tsc -p tsconfig.types.json",
@@ -26,10 +26,10 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@smithy/node-config-provider": "^1.0.1",
-    "@smithy/property-provider": "^1.0.1",
-    "@smithy/types": "^1.1.0",
-    "@smithy/url-parser": "^1.0.1",
+    "@smithy/node-config-provider": "^1.0.3",
+    "@smithy/property-provider": "^1.1.0",
+    "@smithy/types": "^2.0.0",
+    "@smithy/url-parser": "^1.0.3",
     "tslib": "^2.5.0"
   },
   "devDependencies": {