-
Notifications
You must be signed in to change notification settings - Fork 247
/
cloudwatch-log-group-helper.ts
67 lines (57 loc) · 2.37 KB
/
cloudwatch-log-group-helper.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
/**
* Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance
* with the License. A copy of the License is located at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* or in the 'license' file accompanying this file. This file is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES
* OR CONDITIONS OF ANY KIND, express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
import { DefaultLogGroupProps } from './cloudwatch-log-group-defaults';
import * as logs from '@aws-cdk/aws-logs';
import { overrideProps } from './utils';
import { Construct } from '@aws-cdk/core';
export function buildLogGroup(scope: Construct, logGroupId?: string, logGroupProps?: logs.LogGroupProps): logs.LogGroup {
let _logGroupProps: logs.LogGroupProps;
// Override user provided CW LogGroup props with the DefaultLogGroupProps
if (logGroupProps !== undefined) {
_logGroupProps = overrideProps(DefaultLogGroupProps(), logGroupProps);
} else {
_logGroupProps = DefaultLogGroupProps();
}
// Set the LogGroup Id
const _logGroupId = logGroupId ? logGroupId : 'CloudWatchLogGroup';
// Create the CW Log Group
const logGroup = new logs.LogGroup(scope, _logGroupId, _logGroupProps);
// If required, suppress the Cfn Nag WARNINGS
const cfnLogGroup: logs.CfnLogGroup = logGroup.node.defaultChild as logs.CfnLogGroup;
if (_logGroupProps.retention === logs.RetentionDays.INFINITE) {
cfnLogGroup.cfnOptions.metadata = {
cfn_nag: {
rules_to_suppress: [{
id: 'W86',
reason: 'Retention period for CloudWatchLogs LogGroups are set to \'Never Expire\' to preserve customer data indefinitely'
}]
}
};
}
if (!_logGroupProps.encryptionKey) {
const suppressMsg = {
id: 'W84',
reason: 'By default CloudWatchLogs LogGroups data is encrypted using the CloudWatch server-side encryption keys (AWS Managed Keys)'
};
if (cfnLogGroup.cfnOptions.metadata?.cfn_nag.rules_to_suppress) {
cfnLogGroup.cfnOptions.metadata?.cfn_nag.rules_to_suppress.push(suppressMsg);
} else {
cfnLogGroup.cfnOptions.metadata = {
cfn_nag: {
rules_to_suppress: [suppressMsg]
}
};
}
}
return logGroup;
}