aws/aws-cdk

Add HttpNamespace.fromHttpNamespaceName (or .from...Arn) static method

Open

#7,729 opened on May 1, 2020

View on GitHub
 (6 comments) (10 reactions) (0 assignees)TypeScript (10,710 stars) (3,530 forks)batch import
@aws-cdk/aws-servicediscoveryeffort/mediumfeature-requestgood first issuep2

Description

Right now there is only fromHttpNamespaceAttributes, which requires namespace's Arn, Id and Name, which is redundant and requires unnecessarily storing (and fetching) 3 parameters in SSM (in order to be able to 'recreate' Namespace in stacks)

Would be useful to have a similar method that'd require just one parameter.

This is a :rocket: Feature Request

Contributor guide

Tech stack
typescriptaws
Domain
apideveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
knowledge of AWS CDKTypeScriptunderstanding of HttpNamespace class
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine the existing implementation of `fromHttpNamespaceAttributes` in the `aws servicediscovery` module. Understand the current pattern for constructing an HttpNamespace from ARN, ID, and Name. Then, implement a new static method `fromHttpNamespaceName` that takes only the namespace name. Look for similar patterns in the CDK codebase where a single parameter factory method exists (e.g., fromArn, fromName). Ensure the new method calls `fromHttpNamespaceAttributes` with the appropriate lookup logic. Add unit tests and update the module's API documentation. Check the issue comments for any additional discussion on desired behavior.