developer-toolkit-elasticache 1.0.0__tar.gz

developer_toolkit_elasticache-1.0.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

developer_toolkit_elasticache-1.0.0/NOTICE

@@ -0,0 +1,2 @@
+Developer Toolkit for Amazon ElastiCache
+Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

developer_toolkit_elasticache-1.0.0/PKG-INFO

@@ -0,0 +1,145 @@
+Metadata-Version: 2.4
+Name: developer-toolkit-elasticache
+Version: 1.0.0
+Summary: Developer toolkit for Amazon ElastiCache
+License-Expression: Apache-2.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: botocore>=1.43.0
+Dynamic: license-file
+
+# Developer Toolkit for Amazon ElastiCache (Python)
+
+This is a developer toolkit for working with Amazon ElastiCache, as a Python library and
+CLI.
+It provides a function to generate an [IAM authentication token](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/auth-iam.html) that Amazon ElastiCache requires as the
+connection password for an IAM-enabled user. 
+
+## Installation
+
+Requires Python 3.10–3.14 and `pip`. Install from PyPI:
+
+```bash
+python3 -m pip install developer-toolkit-elasticache
+```
+
+If you don't have [`pip`](https://pip.pypa.io) installed, this
+[Python installation guide](https://docs.python-guide.org/starting/installation/) can
+guide you through the process.
+
+This installs the library and the `developer-toolkit-elasticache` command. To install
+from source instead, clone the repository and run `python3 -m pip install .` from the
+`python/` directory.
+
+## Usage
+
+To generate a usable token you need:
+
+- An Amazon ElastiCache serverless cache or replication group with the following:
+  - Valkey 7.2 and above or Redis OSS 7.0 and above
+  - In-transit Encryption (TLS) enabled
+  - IAM-enabled user that has access to to the cache.
+- AWS credentials on the default credential chain (environment variables, shared
+  config files, or an instance/container role), for an identity with the
+  `elasticache:Connect` permission to the cache.
+
+### Generate a token
+
+```python
+from developer_toolkit_elasticache import generate_iam_auth_token
+
+token = generate_iam_auth_token(
+    serverless_cache_name="my-cache",  # or replication_group_id="my-group"
+    user_id="iam-user",
+    region="us-east-1",
+)
+```
+Use the returned token as the password when connecting to the cache.
+
+**Arguments**
+
+- `serverless_cache_name` or `replication_group_id` (string) [one required]
+The serverless cache or node-based replication group to sign for. 
+- `user_id` (string) [required]
+The IAM-enabled user to authenticate as.
+- `region` (string) [optional]
+The AWS region. Defaults to your AWS configuration (`AWS_REGION`,
+`AWS_DEFAULT_REGION`, or the `region` in your profile, in that order).
+
+**Credentials**
+
+Credentials are resolved through the standard AWS credential provider chain
+and are re-read on every call, so rotated credentials are picked up for every new token generation.
+The chain is checked in this order:
+
+1. Environment variables (`AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, and
+   `AWS_SESSION_TOKEN`).
+2. The shared credentials and config files (`~/.aws/credentials`, `~/.aws/config`),
+   selected by `AWS_PROFILE`, including any assume-role or SSO configuration.
+3. Container credentials (Amazon ECS / EKS).
+4. EC2 instance profile credentials (IMDS).
+
+### Reconnecting clients
+
+Clients such as redis-py and valkey-py request credentials on every reconnection.
+Pass them an `ElastiCacheIAMAuthTokenProvider` and call `get_token()` when the
+connection opens, so each connection uses a fresh token:
+
+```python
+from developer_toolkit_elasticache import ElastiCacheIAMAuthTokenProvider
+
+auth = ElastiCacheIAMAuthTokenProvider(
+    serverless_cache_name="my-cache",
+    user_id="iam-user",
+    region="us-east-1",
+)
+username, password = auth.user_id, auth.get_token()
+```
+
+The [`examples/`](examples/) directory has redis-py and valkey-py integrations.
+
+### Command line
+
+```bash
+developer-toolkit-elasticache generate_iam_auth_token \
+  --serverless-cache-name my-cache \
+  --user-id iam-user \
+  --region us-east-1
+```
+
+Add `--region` to sign for a specific region instead of the one resolved from your
+AWS configuration
+
+For the command line, the token is written to stdout, so you can capture it
+directly and pass it to a CLI client through an auth environment variable.
+`REDISCLI_AUTH` works with both `redis-cli` and `valkey-cli`; `VALKEYCLI_AUTH`
+works with `valkey-cli` 9.0.0 and later:
+
+```bash
+export VALKEYCLI_AUTH=$(developer-toolkit-elasticache generate_iam_auth_token \
+  --serverless-cache-name my-cache --user-id iam-user --region us-east-1)
+
+# Example: connecting via valkey-cli
+valkey-cli --tls -h <my-cache-configured-endpoint> --user <iam-user>
+```
+
+## Security
+
+The token is a bearer credential. Keep it out of logs and shell history, and
+connect over TLS. When using a CLI client, you can use the `REDISCLI_AUTH` /
+`VALKEYCLI_AUTH` environment variable to pass the token more safely than the
+`-a` / `--pass` flags, which expose it in the process list.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).

developer_toolkit_elasticache-1.0.0/README.md

@@ -0,0 +1,125 @@
+# Developer Toolkit for Amazon ElastiCache (Python)
+
+This is a developer toolkit for working with Amazon ElastiCache, as a Python library and
+CLI.
+It provides a function to generate an [IAM authentication token](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/auth-iam.html) that Amazon ElastiCache requires as the
+connection password for an IAM-enabled user. 
+
+## Installation
+
+Requires Python 3.10–3.14 and `pip`. Install from PyPI:
+
+```bash
+python3 -m pip install developer-toolkit-elasticache
+```
+
+If you don't have [`pip`](https://pip.pypa.io) installed, this
+[Python installation guide](https://docs.python-guide.org/starting/installation/) can
+guide you through the process.
+
+This installs the library and the `developer-toolkit-elasticache` command. To install
+from source instead, clone the repository and run `python3 -m pip install .` from the
+`python/` directory.
+
+## Usage
+
+To generate a usable token you need:
+
+- An Amazon ElastiCache serverless cache or replication group with the following:
+  - Valkey 7.2 and above or Redis OSS 7.0 and above
+  - In-transit Encryption (TLS) enabled
+  - IAM-enabled user that has access to to the cache.
+- AWS credentials on the default credential chain (environment variables, shared
+  config files, or an instance/container role), for an identity with the
+  `elasticache:Connect` permission to the cache.
+
+### Generate a token
+
+```python
+from developer_toolkit_elasticache import generate_iam_auth_token
+
+token = generate_iam_auth_token(
+    serverless_cache_name="my-cache",  # or replication_group_id="my-group"
+    user_id="iam-user",
+    region="us-east-1",
+)
+```
+Use the returned token as the password when connecting to the cache.
+
+**Arguments**
+
+- `serverless_cache_name` or `replication_group_id` (string) [one required]
+The serverless cache or node-based replication group to sign for. 
+- `user_id` (string) [required]
+The IAM-enabled user to authenticate as.
+- `region` (string) [optional]
+The AWS region. Defaults to your AWS configuration (`AWS_REGION`,
+`AWS_DEFAULT_REGION`, or the `region` in your profile, in that order).
+
+**Credentials**
+
+Credentials are resolved through the standard AWS credential provider chain
+and are re-read on every call, so rotated credentials are picked up for every new token generation.
+The chain is checked in this order:
+
+1. Environment variables (`AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, and
+   `AWS_SESSION_TOKEN`).
+2. The shared credentials and config files (`~/.aws/credentials`, `~/.aws/config`),
+   selected by `AWS_PROFILE`, including any assume-role or SSO configuration.
+3. Container credentials (Amazon ECS / EKS).
+4. EC2 instance profile credentials (IMDS).
+
+### Reconnecting clients
+
+Clients such as redis-py and valkey-py request credentials on every reconnection.
+Pass them an `ElastiCacheIAMAuthTokenProvider` and call `get_token()` when the
+connection opens, so each connection uses a fresh token:
+
+```python
+from developer_toolkit_elasticache import ElastiCacheIAMAuthTokenProvider
+
+auth = ElastiCacheIAMAuthTokenProvider(
+    serverless_cache_name="my-cache",
+    user_id="iam-user",
+    region="us-east-1",
+)
+username, password = auth.user_id, auth.get_token()
+```
+
+The [`examples/`](examples/) directory has redis-py and valkey-py integrations.
+
+### Command line
+
+```bash
+developer-toolkit-elasticache generate_iam_auth_token \
+  --serverless-cache-name my-cache \
+  --user-id iam-user \
+  --region us-east-1
+```
+
+Add `--region` to sign for a specific region instead of the one resolved from your
+AWS configuration
+
+For the command line, the token is written to stdout, so you can capture it
+directly and pass it to a CLI client through an auth environment variable.
+`REDISCLI_AUTH` works with both `redis-cli` and `valkey-cli`; `VALKEYCLI_AUTH`
+works with `valkey-cli` 9.0.0 and later:
+
+```bash
+export VALKEYCLI_AUTH=$(developer-toolkit-elasticache generate_iam_auth_token \
+  --serverless-cache-name my-cache --user-id iam-user --region us-east-1)
+
+# Example: connecting via valkey-cli
+valkey-cli --tls -h <my-cache-configured-endpoint> --user <iam-user>
+```
+
+## Security
+
+The token is a bearer credential. Keep it out of logs and shell history, and
+connect over TLS. When using a CLI client, you can use the `REDISCLI_AUTH` /
+`VALKEYCLI_AUTH` environment variable to pass the token more safely than the
+`-a` / `--pass` flags, which expose it in the process list.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).

developer_toolkit_elasticache-1.0.0/pyproject.toml

@@ -0,0 +1,94 @@
+[build-system]
+# 77 is the first release that understands PEP 639: the bare SPDX expression in
+# `license` below, and the default license-files glob that ships LICENSE/NOTICE in
+# the wheel. Older setuptools only accepts the pre-PEP-639 table form
+# (`license = {text = ...}`) and fails metadata generation outright. Nothing in
+# normal development catches this, because pip's isolated build pulls the newest
+# setuptools regardless of this floor — it only bites a pinned or vendored build.
+requires = ["setuptools>=77.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "developer-toolkit-elasticache"
+version = "1.0.0"
+description = "Developer toolkit for Amazon ElastiCache"
+readme = "README.md"
+license = "Apache-2.0"
+requires-python = ">=3.10"
+dependencies = [
+    "botocore>=1.43.0",
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+
+# Supported Python range — the source for the CI/release test matrices.
+[tool.python-support]
+min = "3.10"
+max = "3.14"
+
+[tool.ruff]
+# The floor in requires-python. Keeps ruff from suggesting syntax that would not
+# run on the oldest interpreter we claim to support.
+target-version = "py310"
+line-length = 90
+
+[tool.ruff.lint]
+extend-select = [
+    "B",    # flake8-bugbear
+    "C4",   # flake8-comprehensions
+    "I",    # isort
+    "INP",  # flake8-no-pep420 (implicit namespace packages)
+    "PL",   # pylint
+    "RUF",  # ruff-specific rules
+    "S",    # flake8-bandit (security)
+    "T20",  # flake8-print
+    "UP",   # pyupgrade
+    "W",    # pycodestyle warnings
+]
+
+# Every rule exempted below must be selected above, or the exemption is inert and
+# the config only looks like it is enforcing something.
+[tool.ruff.lint.per-file-ignores]
+# A CLI's whole job is to write to stdout/stderr, so printing is intended here
+# rather than lint debt.
+"src/developer_toolkit_elasticache/cli.py" = ["T201"]
+# Asserts and magic values are the point of a test, and tests are collected by path
+# rather than imported as a package. S105 fires on the known-answer token strings,
+# which are expected signed URLs to assert against, not secrets.
+"tests/**/*" = ["S101", "PLR2004", "INP001", "S105"]
+# The examples are illustrative scripts whose job is to print, and they are not an
+# importable package.
+"examples/**/*" = ["T201", "INP001"]
+
+[tool.pytest.ini_options]
+# The examples/ scripts are runnable demos that need live AWS credentials and a
+# reachable cache, and they do their work at import time, so collecting one would
+# fail CI. Two independent guards, because testpaths alone is only a default and is
+# silently overridden the moment anyone runs `pytest .` or `pytest <path>`:
+#   1. testpaths     — bare `pytest` looks only at tests/
+#   2. norecursedirs — examples/ is skipped even when a path IS given
+# Keep example filenames clear of test_*.py / *_test.py as well, since a matching
+# name is what turned this into a CI failure in the first place.
+testpaths = ["tests"]
+norecursedirs = ["examples", "build", "dist", ".*"]
+
+[project.scripts]
+developer-toolkit-elasticache = "developer_toolkit_elasticache.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+# PEP 561: py.typed tells a consumer's type checker that the annotations in this
+# package are meant to be used. Without the marker they are ignored downstream no
+# matter how completely the code is annotated, and it has to be declared here or it
+# does not make it into the wheel.
+[tool.setuptools.package-data]
+developer_toolkit_elasticache = ["py.typed"]

developer_toolkit_elasticache-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

developer_toolkit_elasticache-1.0.0/src/developer_toolkit_elasticache/__init__.py

@@ -0,0 +1,22 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+"""Developer Toolkit for Amazon ElastiCache."""
+
+from developer_toolkit_elasticache.errors import (
+    ConfigurationError,
+    InvalidParameterError,
+    ToolkitInputError,
+)
+from developer_toolkit_elasticache.token_generator import (
+    ElastiCacheIAMAuthTokenProvider,
+    generate_iam_auth_token,
+)
+
+__all__ = [
+    "ConfigurationError",
+    "ElastiCacheIAMAuthTokenProvider",
+    "InvalidParameterError",
+    "ToolkitInputError",
+    "generate_iam_auth_token",
+]

developer_toolkit_elasticache-1.0.0/src/developer_toolkit_elasticache/cli.py

@@ -0,0 +1,80 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+import argparse
+import sys
+
+from developer_toolkit_elasticache import generate_iam_auth_token
+from developer_toolkit_elasticache.errors import ToolkitInputError
+
+
+def _add_generate_iam_auth_token_args(parser: argparse.ArgumentParser) -> None:
+    target = parser.add_mutually_exclusive_group(required=True)
+    target.add_argument(
+        "--serverless-cache-name",
+        help="Serverless cache name (the SigV4 signing host)",
+    )
+    target.add_argument(
+        "--replication-group-id",
+        help="Replication group id for a node-based cluster (the SigV4 signing host)",
+    )
+    parser.add_argument(
+        "--user-id",
+        required=True,
+        help="ElastiCache user id (used to build the User ARN in the IAM policy)",
+    )
+    parser.add_argument(
+        "--region",
+        help="AWS region (default: the region resolved from your AWS configuration)",
+    )
+
+
+def _cmd_generate_iam_auth_token(args: argparse.Namespace) -> str | None:
+    return generate_iam_auth_token(
+        user_id=args.user_id,
+        region=args.region,
+        serverless_cache_name=args.serverless_cache_name,
+        replication_group_id=args.replication_group_id,
+    )
+
+
+def _build_parser() -> argparse.ArgumentParser:
+    """Build the top-level parser.
+
+    Each tool contributes one subparser and sets ``func`` to a callable taking the
+    parsed namespace. That callable returns the text to write to stdout, or ``None``
+    if the tool has nothing to print. It signals a user-fixable failure by raising
+    an ``ToolkitInputError`` subclass; ``main`` handles the rest, so adding a tool
+    means adding a subparser here and nothing else.
+    """
+    parser = argparse.ArgumentParser(
+        prog="developer-toolkit-elasticache",
+        description="Developer tools for Amazon ElastiCache",
+    )
+    subparsers = parser.add_subparsers(dest="command", required=True)
+
+    gen = subparsers.add_parser(
+        "generate_iam_auth_token",
+        help="Generate an IAM auth token for an ElastiCache cache",
+    )
+    _add_generate_iam_auth_token_args(gen)
+    gen.set_defaults(func=_cmd_generate_iam_auth_token)
+
+    return parser
+
+
+def main(argv: list[str] | None = None) -> int:
+    args = _build_parser().parse_args(argv)
+
+    try:
+        output = args.func(args)
+    except ToolkitInputError as e:
+        print(f"Error: {e}", file=sys.stderr)
+        return 1
+    if output is not None:
+        print(output)
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())