AWS CDK Node.js Asset Proxy Agent v6

Warnings

• gotcha This library is primarily an environmental utility, not a Python library with direct callable APIs. Its effect is on the `cdk` CLI's behavior when bundling Node.js assets, rather than through direct Python code execution.
  Fix: Simply install the package in the Python environment used by the `cdk` CLI and ensure proxy environment variables (HTTP_PROXY, HTTPS_PROXY, NO_PROXY) are set correctly in the shell.
• gotcha Requires Node.js and the AWS CDK CLI to be installed and correctly configured in your environment. This package acts as an add-on for existing CDK development workflows behind a proxy.
  Fix: Verify that `node --version` and `cdk --version` commands execute successfully. Install Node.js and `aws-cdk` globally if not already present (`npm install -g aws-cdk`).
• breaking The `v6` in the package name indicates compatibility with a specific version or approach of the underlying Node.js proxy agent. Future major versions of AWS CDK or Node.js might introduce breaking changes that require an updated version of this proxy agent.
  Fix: Always check the official `awscdk-asset-node-proxy-agent` GitHub repository and AWS CDK release notes for compatibility announcements when upgrading your CDK CLI or Node.js version.
• gotcha The package requires Python 3.9 or higher. Using it with older Python versions will result in an installation error.
  Fix: Ensure your Python environment is running Python 3.9 or a newer compatible version.

Install

• pip install aws-cdk-asset-node-proxy-agent-v6 Install package

Imports

• aws_cdk_asset_node_proxy_agent_v6

  import aws_cdk_asset_node_proxy_agent_v6

  This package is primarily an environmental utility. Direct import of its contents for typical API calls is not usually required, as its functionality is triggered via environment variables and the CDK CLI.

Quickstart

This package primarily functions by being installed in the Python environment where `cdk` commands are run, and by the presence of standard proxy environment variables (e.g., `HTTPS_PROXY`). The `cdk` CLI automatically detects and uses it when building Node.js assets. The example below shows a basic CDK app with a Node.js Lambda, which would implicitly benefit from the proxy agent if environment variables are set.

import os
from aws_cdk import App, Stack
from aws_cdk.aws_lambda_nodejs import NodejsFunction
from aws_cdk import aws_lambda as _lambda
from constructs import Construct

# This package's functionality relies on its installation and environment variables.
# No direct Python code interaction with aws_cdk_asset_node_proxy_agent_v6 is typical.

# Simulate proxy environment variables that the CDK CLI will pick up.
# In a real scenario, these would be set in your shell before running 'cdk deploy'.
os.environ['HTTPS_PROXY'] = os.environ.get('HTTPS_PROXY', 'http://your.proxy.server:8080')
os.environ['NO_PROXY'] = os.environ.get('NO_PROXY', 'localhost,127.0.0.1,.internal.domain')

class MyProxyAwareNodejsStack(Stack):
    def __init__(self, scope: Construct, id: str, **kwargs) -> None:
        super().__init__(scope, id, **kwargs)

        # A Node.js Lambda function, which will trigger the asset bundling process.
        # If this package is installed and proxy env vars are set, the bundling
        # process will automatically use the proxy agent.
        NodejsFunction(
            self, "MyProxyAwareLambda",
            entry="lambda/handler.ts", # Placeholder: this file would need to exist for a real deploy
            handler="handler",
            runtime=_lambda.Runtime.NODEJS_18_X,
            # Bundling will automatically pick up proxy settings if configured
        )

# Create a CDK app and synthesize the stack
app = App()
MyProxyAwareNodejsStack(app, "ProxyTestStack")
app.synth()

# Note: For a real deployment, ensure 'lambda/handler.ts' exists, Node.js and the
# AWS CDK CLI are installed, and proxy environment variables are correctly set.
# This package should be installed in the same Python environment where you run 'cdk synth' or 'cdk deploy'.