@aws-solutions-constructs/core
Version:
Core CDK Construct for patterns library
86 lines • 12.6 kB
JavaScript
"use strict";
/**
* Copyright 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.
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.buildKinesisStream = buildKinesisStream;
exports.buildKinesisStreamCWAlarms = buildKinesisStreamCWAlarms;
exports.CheckKinesisStreamProps = CheckKinesisStreamProps;
/*
* The functions found here in the core library are for internal use and can be changed
* or removed outside of a major release. We recommend against calling them directly from client code.
*/
// Imports
const kinesis = require("aws-cdk-lib/aws-kinesis");
const kinesis_streams_defaults_1 = require("./kinesis-streams-defaults");
const cdk = require("aws-cdk-lib");
const utils_1 = require("./utils");
const cloudwatch = require("aws-cdk-lib/aws-cloudwatch");
/**
* @internal This is an internal core function and should not be called directly by Solutions Constructs clients.
*/
function buildKinesisStream(scope, props) {
if (props.existingStreamObj) {
return props.existingStreamObj;
}
// Setup the stream properties
// If property overrides have been provided, incorporate them and deploy
const kinesisStreamProps = (0, utils_1.consolidateProps)(kinesis_streams_defaults_1.defaultStreamProps, props.kinesisStreamProps);
// Create the stream and return
return new kinesis.Stream(scope, 'KinesisStream', kinesisStreamProps);
}
/**
* @internal This is an internal core function and should not be called directly by Solutions Constructs clients.
*/
function buildKinesisStreamCWAlarms(scope) {
// Setup CW Alarms for KinesisStream
const alarms = new Array();
// Alarm if Max (GetRecords.IteratorAgeMilliseconds): >= 12 hours (50% of 24 hours default retention period)
alarms.push(new cloudwatch.Alarm(scope, 'KinesisStreamGetRecordsIteratorAgeAlarm', {
metric: new cloudwatch.Metric({
namespace: 'AWS/Kinesis',
metricName: 'GetRecords.IteratorAgeMilliseconds',
statistic: 'Maximum',
period: cdk.Duration.minutes(5),
}),
threshold: 43200000, // 43200000 Milliseconds = 12 Hours (50% of 24 hours - default record retention period)
evaluationPeriods: 1,
comparisonOperator: cloudwatch.ComparisonOperator.GREATER_THAN_OR_EQUAL_TO_THRESHOLD,
alarmDescription: 'Consumer Record Processing Falling Behind, there is risk for data loss due to record expiration.'
}));
// Alarm if Avg (ReadProvisionedThroughputExceeded): > 0
alarms.push(new cloudwatch.Alarm(scope, 'KinesisStreamReadProvisionedThroughputExceededAlarm', {
metric: new cloudwatch.Metric({
namespace: 'AWS/Kinesis',
metricName: 'ReadProvisionedThroughputExceeded',
statistic: 'Average',
period: cdk.Duration.minutes(5),
}),
threshold: 0,
evaluationPeriods: 1,
comparisonOperator: cloudwatch.ComparisonOperator.GREATER_THAN_THRESHOLD,
alarmDescription: 'Consumer Application is Reading at a Slower Rate Than Expected.'
}));
return alarms;
}
function CheckKinesisStreamProps(propsObject) {
let errorMessages = '';
let errorFound = false;
if (propsObject.existingStreamObj && propsObject.kinesisStreamProps) {
errorMessages += 'Error - Either provide existingStreamObj or kinesisStreamProps, but not both.\n';
errorFound = true;
}
if (errorFound) {
throw new Error(errorMessages);
}
}
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"kinesis-streams-helper.js","sourceRoot":"","sources":["kinesis-streams-helper.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG;;AAmCH,gDAYC;AAKD,gEAiCC;AAOD,0DAYC;AAtGD;;;GAGG;AAEH,UAAU;AACV,mDAAmD;AACnD,yEAAgE;AAChE,mCAAmC;AACnC,mCAA2C;AAC3C,yDAAyD;AAoBzD;;GAEG;AACH,SAAgB,kBAAkB,CAAC,KAAgB,EAAE,KAA8B;IAEjF,IAAI,KAAK,CAAC,iBAAiB,EAAE,CAAC;QAC5B,OAAO,KAAK,CAAC,iBAAiB,CAAC;IACjC,CAAC;IAED,8BAA8B;IAC9B,wEAAwE;IACxE,MAAM,kBAAkB,GAAG,IAAA,wBAAgB,EAAC,6CAAkB,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAE1F,+BAA+B;IAC/B,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,eAAe,EAAE,kBAAkB,CAAC,CAAC;AACxE,CAAC;AAED;;GAEG;AACH,SAAgB,0BAA0B,CAAC,KAAgB;IACzD,oCAAoC;IACpC,MAAM,MAAM,GAAuB,IAAI,KAAK,EAAE,CAAC;IAE/C,4GAA4G;IAC5G,MAAM,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,KAAK,EAAE,yCAAyC,EAAE;QACjF,MAAM,EAAE,IAAI,UAAU,CAAC,MAAM,CAAC;YAC5B,SAAS,EAAE,aAAa;YACxB,UAAU,EAAE,oCAAoC;YAChD,SAAS,EAAE,SAAS;YACpB,MAAM,EAAE,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;SAChC,CAAC;QACF,SAAS,EAAE,QAAQ,EAAE,uFAAuF;QAC5G,iBAAiB,EAAE,CAAC;QACpB,kBAAkB,EAAE,UAAU,CAAC,kBAAkB,CAAC,kCAAkC;QACpF,gBAAgB,EAAE,kGAAkG;KACrH,CAAC,CAAC,CAAC;IAEJ,wDAAwD;IACxD,MAAM,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,KAAK,EAAE,qDAAqD,EAAE;QAC7F,MAAM,EAAE,IAAI,UAAU,CAAC,MAAM,CAAC;YAC5B,SAAS,EAAE,aAAa;YACxB,UAAU,EAAE,mCAAmC;YAC/C,SAAS,EAAE,SAAS;YACpB,MAAM,EAAE,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;SAChC,CAAC;QACF,SAAS,EAAE,CAAC;QACZ,iBAAiB,EAAE,CAAC;QACpB,kBAAkB,EAAE,UAAU,CAAC,kBAAkB,CAAC,sBAAsB;QACxE,gBAAgB,EAAE,iEAAiE;KACpF,CAAC,CAAC,CAAC;IAEJ,OAAO,MAAM,CAAC;AAChB,CAAC;AAOD,SAAgB,uBAAuB,CAAC,WAAqC;IAC3E,IAAI,aAAa,GAAG,EAAE,CAAC;IACvB,IAAI,UAAU,GAAG,KAAK,CAAC;IAEvB,IAAI,WAAW,CAAC,iBAAiB,IAAI,WAAW,CAAC,kBAAkB,EAAE,CAAC;QACpE,aAAa,IAAI,iFAAiF,CAAC;QACnG,UAAU,GAAG,IAAI,CAAC;IACpB,CAAC;IAED,IAAI,UAAU,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC;IACjC,CAAC;AACH,CAAC","sourcesContent":["/**\n *  Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n *\n *  Licensed under the Apache License, Version 2.0 (the \"License\"). You may not use this file except in compliance\n *  with the License. A copy of the License is located at\n *\n *      http://www.apache.org/licenses/LICENSE-2.0\n *\n *  or in the 'license' file accompanying this file. This file is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES\n *  OR CONDITIONS OF ANY KIND, express or implied. See the License for the specific language governing permissions\n *  and limitations under the License.\n */\n\n/*\n *  The functions found here in the core library are for internal use and can be changed\n *  or removed outside of a major release. We recommend against calling them directly from client code.\n */\n\n// Imports\nimport * as kinesis from 'aws-cdk-lib/aws-kinesis';\nimport { defaultStreamProps } from './kinesis-streams-defaults';\nimport * as cdk from 'aws-cdk-lib';\nimport { consolidateProps } from './utils';\nimport * as cloudwatch from 'aws-cdk-lib/aws-cloudwatch';\n// Note: To ensure CDKv2 compatibility, keep the import statement for Construct separate\nimport { Construct } from 'constructs';\n\nexport interface BuildKinesisStreamProps {\n  /**\n   * Existing instance of Kinesis Stream, providing both this and `kinesisStreamProps` will cause an error.\n   *\n   * @default - None\n   */\n  readonly existingStreamObj?: kinesis.Stream;\n\n  /**\n   * Optional user provided props to override the default props for the Kinesis stream.\n   *\n   * @default - Default props are used.\n   */\n  readonly kinesisStreamProps?: kinesis.StreamProps\n}\n\n/**\n * @internal This is an internal core function and should not be called directly by Solutions Constructs clients.\n */\nexport function buildKinesisStream(scope: Construct, props: BuildKinesisStreamProps): kinesis.Stream {\n\n  if (props.existingStreamObj) {\n    return props.existingStreamObj;\n  }\n\n  // Setup the stream properties\n  // If property overrides have been provided, incorporate them and deploy\n  const kinesisStreamProps = consolidateProps(defaultStreamProps, props.kinesisStreamProps);\n\n  // Create the stream and return\n  return new kinesis.Stream(scope, 'KinesisStream', kinesisStreamProps);\n}\n\n/**\n * @internal This is an internal core function and should not be called directly by Solutions Constructs clients.\n */\nexport function buildKinesisStreamCWAlarms(scope: Construct): cloudwatch.Alarm[] {\n  // Setup CW Alarms for KinesisStream\n  const alarms: cloudwatch.Alarm[] = new Array();\n\n  // Alarm if Max (GetRecords.IteratorAgeMilliseconds): >= 12 hours (50% of 24 hours default retention period)\n  alarms.push(new cloudwatch.Alarm(scope, 'KinesisStreamGetRecordsIteratorAgeAlarm', {\n    metric: new cloudwatch.Metric({\n      namespace: 'AWS/Kinesis',\n      metricName: 'GetRecords.IteratorAgeMilliseconds',\n      statistic: 'Maximum',\n      period: cdk.Duration.minutes(5),\n    }),\n    threshold: 43200000, // 43200000 Milliseconds = 12 Hours (50% of 24 hours - default record retention period)\n    evaluationPeriods: 1,\n    comparisonOperator: cloudwatch.ComparisonOperator.GREATER_THAN_OR_EQUAL_TO_THRESHOLD,\n    alarmDescription: 'Consumer Record Processing Falling Behind, there is risk for data loss due to record expiration.'\n  }));\n\n  // Alarm if Avg (ReadProvisionedThroughputExceeded): > 0\n  alarms.push(new cloudwatch.Alarm(scope, 'KinesisStreamReadProvisionedThroughputExceededAlarm', {\n    metric: new cloudwatch.Metric({\n      namespace: 'AWS/Kinesis',\n      metricName: 'ReadProvisionedThroughputExceeded',\n      statistic: 'Average',\n      period: cdk.Duration.minutes(5),\n    }),\n    threshold: 0,\n    evaluationPeriods: 1,\n    comparisonOperator: cloudwatch.ComparisonOperator.GREATER_THAN_THRESHOLD,\n    alarmDescription: 'Consumer Application is Reading at a Slower Rate Than Expected.'\n  }));\n\n  return alarms;\n}\n\nexport interface KinesisStreamProps {\n  readonly existingStreamObj?: kinesis.Stream;\n  readonly kinesisStreamProps?: kinesis.StreamProps,\n}\n\nexport function CheckKinesisStreamProps(propsObject: KinesisStreamProps | any) {\n  let errorMessages = '';\n  let errorFound = false;\n\n  if (propsObject.existingStreamObj && propsObject.kinesisStreamProps) {\n    errorMessages += 'Error - Either provide existingStreamObj or kinesisStreamProps, but not both.\\n';\n    errorFound = true;\n  }\n\n  if (errorFound) {\n    throw new Error(errorMessages);\n  }\n}\n"]}