update GuLogShippingPolicy to bring it's own parameter #137
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We've established best practice for accounts/stacks to define the kinesis stream to send logs to to be a SSM Parameter called `/account/services/logging.stream.name`. This updates `GuLogShippingPolicy` to add the parameter to the stack within that construct. The construct is bringing its own resources with it, rather than being passed in as props. This makes it more self contained.
akash1810
commented
Jan 13, 2021
jamie-lynch
approved these changes
Jan 13, 2021
Tweak InstanceRoleProps to make log shipping opt-out, rather than forcing the `includeLogShipping` prop to be set.
akash1810
commented
Jan 13, 2021
| @@ -10,7 +10,8 @@ import { | |||
| GuSSMRunCommandPolicy, | |||
| } from "../constructs/iam"; | |||
|
|
|||
| interface InstanceRoleProps extends GuGetS3ObjectPolicyProps, Partial<GuLogShippingPolicyProps> { | |||
| interface InstanceRoleProps extends GuGetS3ObjectPolicyProps { | |||
| withoutLogShipping?: boolean; // optional to have log shipping added by default, you have to opt out | |||
There was a problem hiding this comment.
We might want to start using https://typedoc.org/ to generate a documentation site and also provide hints via IDEs IntelliSense features.
akash1810
added
the
needs-new-release
This was referenced Jan 13, 2021
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this change?
We've established best practice for accounts/stacks to define the kinesis stream to send logs to to be a SSM Parameter called
/account/services/logging.stream.name.This updates
GuLogShippingPolicyto add the parameter to the stack within that construct. The construct is bringing its own resources with it, rather than being passed in as props. This makes it more self contained.This builds on the BYO* pattern introduced in #91.
Does this change require changes to existing projects or CDK CLI?
Yes! The signature of
InstanceRolehas changed to no longer require a stream name, but simply aincludeLogShippingboolean.How to test
How can we measure success?
Simpler interface to
InstanceRoleand more self contained constructs.Have we considered potential risks?
n/a