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(events): mention property requirements when creating custom events #29287

Merged
merged 4 commits into from
Feb 29, 2024

Conversation

evzzk
Copy link
Contributor

@evzzk evzzk commented Feb 27, 2024

Issue # (if applicable)

Closes #.

Reason for this change

When creating an EventPattern for a custom event, a few properties are required. Documentation currently isn't clear on which properties are required. This change links to AWS documentation that describes the required properties for custom events.

Description of changes

Added text stating that some optional properties are required for custom events and provided link to docs.

Description of how you validated changes

No validation

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 aws-cdk-automation requested a review from a team February 27, 2024 22:27
@github-actions github-actions bot added p2 beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK labels Feb 27, 2024
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

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

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

@evzzk evzzk changed the title docs(aws-events): mention property requirements when creating custom events docs(events): mention property requirements when creating custom events Feb 27, 2024
@aws-cdk-automation aws-cdk-automation dismissed their stale review February 27, 2024 23:29

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

rix0rrr
rix0rrr previously approved these changes Feb 28, 2024
@GavinZZ
Copy link
Contributor

GavinZZ commented Feb 28, 2024

@mergify update

Copy link
Contributor

mergify bot commented Feb 28, 2024

update

✅ Branch has been successfully updated

GavinZZ
GavinZZ previously approved these changes Feb 28, 2024
@GavinZZ GavinZZ dismissed MrArnoldPalmer’s stale review February 28, 2024 18:22

Dismissing as the comments are addressed. Merging this PR.

Copy link
Contributor

mergify bot commented Feb 28, 2024

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).

@mergify mergify bot dismissed stale reviews from rix0rrr and GavinZZ February 29, 2024 17:37

Pull request has been modified.

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

@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 Feb 29, 2024
@GavinZZ
Copy link
Contributor

GavinZZ commented Feb 29, 2024

@mergify merge

Copy link
Contributor

mergify bot commented Feb 29, 2024

merge

❌ Sorry but I didn't understand the command. Please consult the commands documentation 📚.

Copy link
Contributor

mergify bot commented Feb 29, 2024

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).

Copy link
Contributor

mergify bot commented Feb 29, 2024

merge

❌ Sorry but I didn't understand the command. Please consult the commands documentation 📚.

@mergify mergify bot merged commit 6fe97ea into aws:main Feb 29, 2024
15 checks passed
Copy link
Contributor

mergify bot commented Feb 29, 2024

merge

❌ Sorry but I didn't understand the command. Please consult the commands documentation 📚.

@aws-cdk-automation aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Feb 29, 2024
Copy link
Contributor

mergify bot commented Feb 29, 2024

merge

❌ Sorry but I didn't understand the command. Please consult the commands documentation 📚.

1 similar comment
Copy link
Contributor

mergify bot commented Feb 29, 2024

merge

❌ Sorry but I didn't understand the command. Please consult the commands documentation 📚.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK p2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants