@karmaniverous/get-dotenv
    Preparing search index...

    Interface ResolveAwsContextOptions

    Arguments for resolving AWS context (profile/region/credentials).

    interface ResolveAwsContextOptions {
        cfg: {
            defaultRegion?: string;
            loginOnDemand?: boolean;
            profile?: string;
            profileFallbackKey?: string;
            profileKey?: string;
            region?: string;
            regionKey?: string;
            strategy?: "none" | "cli-export";
        };
        dotenv: ProcessEnv;
    }
    Index

    Properties

    cfg dotenv

    Properties

    cfg: {
        defaultRegion?: string;
        loginOnDemand?: boolean;
        profile?: string;
        profileFallbackKey?: string;
        profileKey?: string;
        region?: string;
        regionKey?: string;
        strategy?: "none" | "cli-export";
    }

    Plugin configuration.

    Type Declaration

    • OptionaldefaultRegion?: string

      Fallback region when region cannot be resolved from config/dotenv/AWS CLI.

    • OptionalloginOnDemand?: boolean

      When true, attempt aws sso login on-demand when credential export fails for an SSO profile.

    • Optionalprofile?: string

      Preferred AWS profile name (overrides dotenv-derived profile keys when set).

    • OptionalprofileFallbackKey?: string

      Dotenv/config fallback key for profile lookup (default AWS_PROFILE).

    • OptionalprofileKey?: string

      Dotenv/config key for local profile lookup (default AWS_LOCAL_PROFILE).

    • Optionalregion?: string

      Preferred AWS region (overrides dotenv-derived region key when set).

    • OptionalregionKey?: string

      Dotenv/config key for region lookup (default AWS_REGION).

    • Optionalstrategy?: "none" | "cli-export"

      Credential acquisition strategy.

      • 'cli-export': resolve via AWS CLI
      • 'none': skip credential resolution
    dotenv: ProcessEnv

    The current composed dotenv variables.

    Settings

    Member Visibility

    On This Page

    Properties