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

    Interface AwsCommandOptionValues

    Option values parsed for the aws command mount.

    This interface exists to keep TypeDoc output stable and fully documented (avoids inferred __type.* warnings).

    interface AwsCommandOptionValues {
        defaultRegion?: string;
        loginOnDemand?: boolean;
        profile?: string;
        profileFallbackKey?: string;
        profileKey?: string;
        region?: string;
        regionKey?: string;
        strategy?: "none" | "cli-export";
        [key: string]: unknown;
    }

    Hierarchy

    Indexable

    • [key: string]: unknown
    Index

    Properties

    defaultRegion? loginOnDemand? profile? profileFallbackKey? profileKey? region? regionKey? strategy?

    Properties

    defaultRegion?: string

    Fallback region when no region can be resolved.

    loginOnDemand?: boolean

    Attempt AWS SSO login on-demand when exporting credentials fails and the profile looks SSO.

    profile?: string

    AWS profile name to use for this invocation.

    profileFallbackKey?: string

    Dotenv/config fallback key for profile lookup.

    profileKey?: string

    Dotenv/config key for local profile lookup.

    region?: string

    AWS region to use for this invocation.

    regionKey?: string

    Dotenv/config key for region lookup.

    strategy?: "none" | "cli-export"

    Credential acquisition strategy.

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

    Settings

    Member Visibility

    On This Page

    Properties