-
Notifications
You must be signed in to change notification settings - Fork 4.5k
aws-cdk-lib.aws_apigatewayv2: confusing wording for HttpApi.disableExecuteApiEndpoint #31729
Copy link
Copy link
Closed
Labels
@aws-cdk/aws-apigatewayv2Related to Amazon API Gateway v2Related to Amazon API Gateway v2documentationThis is a problem with documentation.This is a problem with documentation.effort/smallSmall work item – less than a day of effortSmall work item – less than a day of effortp2
Description
Describe the issue
disableExecuteApiEndpoint?
Type:
boolean(optional, default: false execute-api endpoint enabled.)Specifies whether clients can invoke your API using the default endpoint.
By default, clients can invoke your API with the default
https://{api_id}.execute-api.{region}.amazonaws.comendpoint. Enable this if you would like clients to use your custom domain name.
I think this means if you want to use a custom domain you should set disableExecuteApiEndpoint=true ?
I'm pretty sure that's how I would want it to behave.
It is confusing because the wording says "enable this" but the param is called "disable...", so it's unclear if it means to enable the disabling flag, or to enable the thing that the disabling flag disables.
Links
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
@aws-cdk/aws-apigatewayv2Related to Amazon API Gateway v2Related to Amazon API Gateway v2documentationThis is a problem with documentation.This is a problem with documentation.effort/smallSmall work item – less than a day of effortSmall work item – less than a day of effortp2