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.

Sign up for GitHub

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

Jump to bottom

aws_cdk.aws_cloudtrail.Trail: KMS encryption kms_key example incorrect #29222

Closed
ayankowsky opened this issue Feb 22, 2024 · 2 comments · Fixed by #29234
Closed

aws_cdk.aws_cloudtrail.Trail: KMS encryption kms_key example incorrect #29222

ayankowsky opened this issue Feb 22, 2024 · 2 comments · Fixed by #29234
Labels
@aws-cdk/aws-cloudtrail Related to AWS CloudTrail documentation This is a problem with documentation. p2

Comments

@ayankowsky
Copy link

Describe the issue

The example for aws_cdk.aws_cloudtrail.Trail provides an incorrect example of setting an encryption key:

trail = cloudtrail.Trail(self, "myCloudTrail",
    send_to_cloud_watch_logs=True,
    kms_key=my_key_alias
)

kms_key is incorrect and should be changed to encryption_key:

trail = cloudtrail.Trail(self, "myCloudTrail",
    send_to_cloud_watch_logs=True,
    encryption_key=my_key_alias
)

Links

https://docs.aws.amazon.com/cdk/api/v2/python/aws_cdk.aws_cloudtrail/Trail.html
@ayankowsky ayankowsky added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Feb 22, 2024
@github-actions github-actions bot added the @aws-cdk/aws-cloudtrail Related to AWS CloudTrail label Feb 22, 2024
@tim-finnigan tim-finnigan self-assigned this Feb 22, 2024
@tim-finnigan tim-finnigan added investigating This issue is being investigated and/or work is in progress to resolve the issue. and removed needs-triage This issue or PR still needs to be triaged. labels Feb 22, 2024
@tim-finnigan
Copy link

Thanks for reporting, looks like it should be encryption_key in that example.

@tim-finnigan tim-finnigan added p2 and removed investigating This issue is being investigated and/or work is in progress to resolve the issue. labels Feb 22, 2024
@tim-finnigan tim-finnigan removed their assignment Feb 22, 2024
@msambol msambol mentioned this issue Feb 23, 2024
Merged
@mergify mergify bot closed this as completed in #29234 Feb 23, 2024
mergify bot pushed a commit that referenced this issue Feb 23, 2024
@msambol
chore(kms): incorrect parameter name in doc (#29234)
0989e76 
Closes #29222.

----

*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
Copy link

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

@github-actions github-actions bot mentioned this issue Mar 1, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
@aws-cdk/aws-cloudtrail Related to AWS CloudTrail documentation This is a problem with documentation. p2
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore(kms): incorrect parameter name in doc msambol/aws-cdk
2 participants
@ayankowsky @tim-finnigan