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

[AWS::Timestream::ScheduledQuery] - [BUG] - ClientToken without apparent purpose in CloudFormation context

Open
#2,453 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::Timestream::ScheduledQuery

### Resource Name

AWS::Timestream::ScheduledQuery

### Issue Description

The [resource parameters ](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-timestream-scheduledquery.htmlinclude ClientToken with the description

> Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making multiple identical CreateScheduledQuery requests has the same effect as making a single request.

I think this does not make sense in the CloudFormation context and is just a copied over remnant from the [CreateScheduledQuery API](https://docs.aws.amazon.com/timestream/latest/developerguide/API_query_CreateScheduledQuery.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 with the documented AWS::Timestream::ScheduledQuery resource parameters and compare ClientToken with the linked CreateScheduledQuery API documentation. Confirm whether CloudFormation uses the parameter for idempotency; done means documenting its purpose or removing it from the resource parameters if it has none.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws
Domain
cloud
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 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.