Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(apigatewayv2): rephrased the documentation for HttpApiProps.disableExecuteApiEndpoint to make it more clearer. #31734

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ashishdhingra
Copy link
Contributor

Issue # (if applicable)

Closes #31729.

Reason for this change

The current documentation for disableExecuteApiEndpoint at HttpApi 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 forDisableExecuteApiEndpoint at AWS::ApiGatewayV2::Api.

Description of how you validated changes

N/A

Checklist


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 9fa5769
  • Result: FAILED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution/core This is a PR that came from AWS. p2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

aws-cdk-lib.aws_apigatewayv2: confusing wording for HttpApi.disableExecuteApiEndpoint
2 participants