aws / aws-sdk

Landing page for the AWS SDKs on GitHub
https://aws.amazon.com/tools/
Other
71 stars 14 forks source link

ECS Client has missing SettingName for the dualStackIPv6 option #800

Open jmenga-aset opened 6 months ago

jmenga-aset commented 6 months ago

Checkboxes for prior research

Describe the bug

The ECS Client SettingName enum is missing an option for the dualStackIPv6 option (as indicated here)

SDK version number

@aws-sdk/client-ecs@3.529.1

Which JavaScript Runtime is this issue in?

Node.js

Details of the browser/Node.js/ReactNative version

v20.10.0

Reproduction Steps

import { SettingName } from '@aws-sdk/client-ecs'

console.log(SettingName)

Observed Behavior

The following output is generated:

{
  AWSVPC_TRUNKING: 'awsvpcTrunking',
  CONTAINER_INSIGHTS: 'containerInsights',
  CONTAINER_INSTANCE_LONG_ARN_FORMAT: 'containerInstanceLongArnFormat',
  FARGATE_FIPS_MODE: 'fargateFIPSMode',
  FARGATE_TASK_RETIREMENT_WAIT_PERIOD: 'fargateTaskRetirementWaitPeriod',
  GUARD_DUTY_ACTIVATE: 'guardDutyActivate',
  SERVICE_LONG_ARN_FORMAT: 'serviceLongArnFormat',
  TAG_RESOURCE_AUTHORIZATION: 'tagResourceAuthorization',
  TASK_LONG_ARN_FORMAT: 'taskLongArnFormat'
}

Expected Behavior

There should be a key/value pair for the value dualStackIPv6

e.g.

{
  DUAL_STACK_IPV6: 'dualStackIPv6'
}

Possible Solution

Update the SettingName object to the following:

export const SettingName = {
  AWSVPC_TRUNKING: "awsvpcTrunking",
  CONTAINER_INSIGHTS: "containerInsights",
  CONTAINER_INSTANCE_LONG_ARN_FORMAT: "containerInstanceLongArnFormat",
  DUAL_STACK_IPV6: 'dualStackIPv6'
  FARGATE_FIPS_MODE: "fargateFIPSMode",
  FARGATE_TASK_RETIREMENT_WAIT_PERIOD: "fargateTaskRetirementWaitPeriod",
  GUARD_DUTY_ACTIVATE: "guardDutyActivate",
  SERVICE_LONG_ARN_FORMAT: "serviceLongArnFormat",
  TAG_RESOURCE_AUTHORIZATION: "tagResourceAuthorization",
  TASK_LONG_ARN_FORMAT: "taskLongArnFormat",
} as const;

Additional Information/Context

No response

RanVaknin commented 6 months ago

Hi @jmenga-aset ,

Thanks for reaching out. Its not clear if this was never modeled, or was removed. I'm curious, if you had to supply the string value directly instead of using the enum, does dualStackIPv6 actually work?

The reason why I'm asking is sometimes service teams remove enum values (in favor of introducing new parameters or deprecating old ones) and forget to remove the corresponding documentation.

Thanks, Ran~

github-actions[bot] commented 5 months ago

This issue has not received a response in 1 week. If you still think there is a problem, please leave a comment to avoid the issue from automatically closing.

mixja commented 5 months ago

Yes dualStackIPv6 is a documented setting and works - see docs

RanVaknin commented 1 month ago

Hi there,

I have created an internal ticket (P146481495) with the EC2 service team for them to update their model with the missing enum. Since the AWS SDKs are code-generated from those API models, the SDK team cannot add those directly. Instead, the service team itself would be the one needing to make the change on the backend.

Moving to cross SDK repo for tracking.

Thank, Ran~