nija-at
commented
4 years ago Thanks for filing this issue @Jhawins.
This is not an internal value for the service. It's in fact the part of the URI documented here, specifically the part of the URI under service.
Nevertheless, I do agree with you that marking this field as a string is not a very good user experience.
One way this can be improved is by defining a new type that provides a set of known combined values for service and subdomain. We can then deprecate these two fields and use a new property of this type.
Something like this - https://github.com/aws/aws-cdk/blob/master/packages/%40aws-cdk/aws-apigatewayv2/lib/http/integration.ts#L35
github-actions[bot]
andremmfaria
florianbachl
https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-apigateway.AwsIntegrationProps.html
The type for
service(name) is simplystring, while this may be adequate for services like "s3" (the given example) this does not provide adequate documentation for other services.For DynamoDB for example, is it DynamoDB? Is it Dynamo? Dynamo_DB? This is just one example, there is a multitude of
stringtypes that should undoubtedly use Enums for self-documentation.I would open a PR to add the enums but there is no way for me to discover the proper values but trial-and-error.
It may be possible that this is for internal naming and does not correspond to the actual Service Name within AWS.. If this is the case it is a much simpler fix to convey that this is an internal service name.
This is a 📕 documentation issue