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

docs(custom-resource): add example for AwsApiCall #26621

Merged
merged 10 commits into from
Aug 10, 2023

Conversation

ymhiroki
Copy link
Contributor

@ymhiroki ymhiroki commented Aug 3, 2023

There weren't any examples for AwsApiCall in the document other than the Overview.
This commit adds examples to the document of AwsApiCall and it helps users understand the usage.


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

@github-actions github-actions bot added p2 repeat-contributor [Pilot] contributed between 3-5 PRs to the CDK labels Aug 3, 2023
@aws-cdk-automation aws-cdk-automation requested a review from a team August 3, 2023 12:07
@aws-cdk-automation aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Aug 3, 2023
@ymhiroki ymhiroki changed the title docs(custom-resource): add example for AwsApiCall in v2 and v3 docs(custom-resource): add example for AwsApiCall in sdk v2 and v3 Aug 4, 2023
@aws-cdk-automation aws-cdk-automation added pr/needs-maintainer-review This PR needs a review from a Core Team Member and removed pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. labels Aug 4, 2023
rix0rrr
rix0rrr previously requested changes Aug 4, 2023
Copy link
Contributor

@rix0rrr rix0rrr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey, thanks for this!

I was confused about how a user chooses between v2 and v3 on the custom resource, but I see from the README that it's done by registering a special fact. That information is missing here, which might be a bit confusing.

But I think we might change something about this construct anyway, so let's hold off on this change a little until we've settled on how it works.

@aws-cdk-automation aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Aug 4, 2023
@rix0rrr
Copy link
Contributor

rix0rrr commented Aug 4, 2023

Okay yeah, the v3 documentation is out of date. See the following PR: #26631

@mergify mergify bot dismissed rix0rrr’s stale review August 8, 2023 05:55

Pull request has been modified.

@ymhiroki ymhiroki changed the title docs(custom-resource): add example for AwsApiCall in sdk v2 and v3 docs(custom-resource): add example for AwsApiCall in SDKv3 Aug 8, 2023
@ymhiroki
Copy link
Contributor Author

ymhiroki commented Aug 8, 2023

@rix0rrr Thanks for your comments!
I updated the PR to use only SDKv3. How about it?

@ymhiroki ymhiroki requested a review from rix0rrr August 8, 2023 06:31
@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Aug 8, 2023
@rix0rrr
Copy link
Contributor

rix0rrr commented Aug 8, 2023

I updated the PR to use only SDKv3. How about it?

I meant the other way around. It should all be only SDKv2-style strings.

rix0rrr
rix0rrr previously requested changes Aug 8, 2023
Copy link
Contributor

@rix0rrr rix0rrr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I meant the other way around. It should all be only SDKv2-style strings.

@aws-cdk-automation aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Aug 8, 2023
@mergify mergify bot dismissed rix0rrr’s stale review August 8, 2023 08:23

Pull request has been modified.

@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Aug 8, 2023
@ymhiroki
Copy link
Contributor Author

ymhiroki commented Aug 8, 2023

I see. I fixed it.

@ymhiroki ymhiroki requested a review from rix0rrr August 8, 2023 09:06
Copy link
Contributor

@rix0rrr rix0rrr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@rix0rrr rix0rrr changed the title docs(custom-resource): add example for AwsApiCall in SDKv3 docs(custom-resource): add example for AwsApiCall Aug 10, 2023
@aws-cdk-automation aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Aug 10, 2023
@mergify
Copy link
Contributor

mergify bot commented Aug 10, 2023

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: e89c2c3
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

@mergify mergify bot merged commit c5ca122 into aws:main Aug 10, 2023
9 checks passed
@mergify
Copy link
Contributor

mergify bot commented Aug 10, 2023

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@ymhiroki ymhiroki deleted the doc-custom-resource branch November 7, 2023 14:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
p2 repeat-contributor [Pilot] contributed between 3-5 PRs to the CDK
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants