cdk-assume-role-plugin
    TypeScript icon, indicating that this package has built-in type declarations

    1.2.0 • Public • Published

    cdk-assume-role-plugin

    Build Status

    Adds assume role and mfa support to cdk apps

    ⚠️ This is experimental and subject to breaking changes.

    Installation

    npm install cdk-assume-role-plugin

    How to use

    There are two ways to tell cdk to use the plugin. The first way is to include an explicit --plugin option whenever you use a cdk command.

    npx cdk deploy --plugin "cdk-assume-role-plugin" *Stack

    The second way is to add the following entry to the cdk.json file

    // cdk.json
    {
      "app": "npx ts-node bin/YOURAPP.ts",
      "plugin": ["cdk-assume-role-plugin"]
    }

    Finally, add the account / profile mapping in the package.json

    // package.json
    {
        ...
        "devDependencies": {
            "aws-cdk": "^1.15.0",
            "cdk-assume-role-plugin": "^0.0.1",
            ...
        },
        ...
        "cdkAssumeRolePlugin": {
          "userProfile": "idp",
          "roles": {
            "YOUR_ACCOUNT_ID": "YOUR_ROLE_NAME",
            "YOUR_ACCOUNT_ID": "YOUR_ROLE_NAME"
          }
        }
    }

    Environment Variables

    The plugin supports the following environment variables:

    • AWS_SHARED_CREDENTIALS_FILE – Specifies the location of the file that the AWS CLI uses to store access keys. The default path is ~/.aws/credentials).
    • IGNORE_CDK_ASSUME_ROLE_PLUGIN=true - Turn off the plugin. Defaults to false.
    • CDK_ASSUME_ROLE_PLUGIN_CONFIG - Specifies the localtion of the global plugin config. Defaults to ~/.cdkassumeroleplugin.json

    License

    MIT

    Install

    npm i cdk-assume-role-plugin

    DownloadsWeekly Downloads

    5

    Version

    1.2.0

    License

    MIT

    Unpacked Size

    46.4 kB

    Total Files

    19

    Last publish

    Collaborators

    • avatar