Skip to content

Commit 1db9be7

Browse files
chore(apigatewayv2): rephrased the documentation for HttpApiProps.disableExecuteApiEndpoint to make it more clearer. (#31734)
### Issue # (if applicable) Closes #31729. ### Reason for this change The current documentation for `disableExecuteApiEndpoint` at [HttpApi](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.HttpApi.html#disableexecuteapiendpoint) is confusing. It states that: ``` 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.com endpoint. Enable this if you would like clients to use your custom domain name. ``` ### Description of changes Rephrased the documentation for `HttpApiProps.disableExecuteApiEndpoint` to make it more clearer. Refer documentation for`DisableExecuteApiEndpoint` at [AWS::ApiGatewayV2::Api](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-disableexecuteapiendpoint). ### Description of how you validated changes N/A ### Checklist - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent edd031d commit 1db9be7

File tree

1 file changed

+2
-2
lines changed
  • packages/aws-cdk-lib/aws-apigatewayv2/lib/http

1 file changed

+2
-2
lines changed

packages/aws-cdk-lib/aws-apigatewayv2/lib/http/api.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -140,8 +140,8 @@ export interface HttpApiProps {
140140
/**
141141
* Specifies whether clients can invoke your API using the default endpoint.
142142
* By default, clients can invoke your API with the default
143-
* `https://{api_id}.execute-api.{region}.amazonaws.com` endpoint. Enable
144-
* this if you would like clients to use your custom domain name.
143+
* `https://{api_id}.execute-api.{region}.amazonaws.com` endpoint. Set this to
144+
* true if you would like clients to use your custom domain name.
145145
* @default false execute-api endpoint enabled.
146146
*/
147147
readonly disableExecuteApiEndpoint?: boolean;

0 commit comments

Comments
 (0)