aws-cloudformation / aws-cloudformation/cloudformation-coverage-roadmap

[AWS::Grafana::Workspace] - [BUG] - ClientToken without apparent purpose in CloudFormation context

Open
#2,447 0 comments 1 reaction 0 assignees View on GitHub
bug
Dominant language
No language data
Stars
1.1k
Forks
62
PR merge metrics
No merged PRs in 30d

Description

### Name of the resource

AWS::Grafana::Workspace

### Resource Name

AWS::Grafana::Workspace

### Issue Description

The [resource parameters ](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-grafana-workspace.html) include ClientToken with the description `A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.`

I think this does not make sense in the CloudFormation context and is just a copied over remnant from the [CreateWorkspace API](https://docs.aws.amazon.com/grafana/latest/APIReference/API_CreateWorkspace.html). For the API it makes sense to be idempotent, but not for the deployment model of Cloudformation.
If it serves no purpose, it should be removed.

### Expected Behavior

ClientToken having a purpose or not be a parameter.

### Observed Behavior

ClientToken being a parameter without apparent purpose.

### Test Cases

documented resource parameters

### Other Details

_No response_

Contributor guide

Open the contributing guide

Research direction

Start by comparing the AWS::Grafana::Workspace resource parameters with the linked CreateWorkspace API documentation, focusing on ClientToken and CloudFormation behavior. Confirm whether ClientToken has a CloudFormation-specific purpose; done means its purpose is documented or the parameter is removed from the resource documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, grafana
Domain
cloud, observability
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.