@gradientedge/cdk-utils 8.90.0 → 8.92.0

package/src/lib/services/aws/step-function/types.ts

@@ -20,40 +20,30 @@ import {
 } from 'aws-cdk-lib/aws-stepfunctions-tasks'
 
 /**
- * @category cdk-utils.step-functions-manager
- * @subcategory Properties
  */
 export interface SfnSucceedProps extends SucceedProps {
   name: string
 }
 
 /**
- * @category cdk-utils.step-functions-manager
- * @subcategory Properties
  */
 export interface SfnRetryProps extends RetryProps {
   intervalInSecs: number
 }
 
 /**
- * @category cdk-utils.step-functions-manager
- * @subcategory Properties
  */
 export interface SfnFailProps extends FailProps {
   name: string
 }
 
 /**
- * @category cdk-utils.step-functions-manager
- * @subcategory Properties
  */
 export interface SfnPassProps extends PassProps {
   name: string
 }
 
 /**
- * @category cdk-utils.step-functions-manager
- * @subcategory Properties
  */
 export interface SfnDynamoGetItemProps extends DynamoGetItemProps {
   name: string
@@ -61,8 +51,6 @@ export interface SfnDynamoGetItemProps extends DynamoGetItemProps {
 }
 
 /**
- * @category cdk-utils.step-functions-manager
- * @subcategory Properties
  */
 export interface SfnDynamoPutItemProps extends DynamoPutItemProps {
   name: string
@@ -70,8 +58,6 @@ export interface SfnDynamoPutItemProps extends DynamoPutItemProps {
 }
 
 /**
- * @category cdk-utils.step-functions-manager
- * @subcategory Properties
  */
 export interface SfnDynamoDeleteItemProps extends DynamoDeleteItemProps {
   name: string
@@ -79,8 +65,6 @@ export interface SfnDynamoDeleteItemProps extends DynamoDeleteItemProps {
 }
 
 /**
- * @category cdk-utils.step-functions-manager
- * @subcategory Properties
  */
 export interface SfnSqsSendMessageProps extends SqsSendMessageProps {
   name: string
@@ -88,8 +72,6 @@ export interface SfnSqsSendMessageProps extends SqsSendMessageProps {
 }
 
 /**
- * @category cdk-utils.step-functions-manager
- * @subcategory Properties
  */
 export interface SfnParallelProps extends ParallelProps {
   name: string
@@ -97,16 +79,12 @@ export interface SfnParallelProps extends ParallelProps {
 }
 
 /**
- * @category cdk-utils.step-functions-manager
- * @subcategory Properties
  */
 export interface SfnChoiceProps extends ChoiceProps {
   name: string
 }
 
 /**
- * @category cdk-utils.step-functions-manager
- * @subcategory Properties
  */
 export interface SfnWaitProps extends WaitProps {
   name: string
@@ -114,8 +92,6 @@ export interface SfnWaitProps extends WaitProps {
 }
 
 /**
- * @category cdk-utils.step-functions-manager
- * @subcategory Properties
  */
 export interface SfnLambdaInvokeProps extends LambdaInvokeProps {
   name: string
@@ -123,8 +99,6 @@ export interface SfnLambdaInvokeProps extends LambdaInvokeProps {
 }
 
 /**
- * @category cdk-utils.step-functions-manager
- * @subcategory Properties
  */
 export interface SfnCallApiGatewayRestApiEndpointProps extends CallApiGatewayRestApiEndpointProps {
   name: string
@@ -132,20 +106,14 @@ export interface SfnCallApiGatewayRestApiEndpointProps extends CallApiGatewayRes
 }
 
 /**
- * @category cdk-utils.step-functions-manager
- * @subcategory Properties
  */
 export interface SfnStateMachineProps extends StateMachineProps {}
 
 /**
- * @category cdk-utils.sfn-manager
- * @subcategory Properties
  */
 export interface SfnMapProps extends MapProps {}
 
 /**
- * @category cdk-utils.sfn-manager
- * @subcategory Properties
  */
 export interface SfnStartExecutionProps extends StepFunctionsStartExecutionProps {
   retries?: SfnRetryProps[]

package/src/lib/services/aws/systems-manager/main.ts

@@ -5,9 +5,6 @@ import { CommonConstruct } from '../../../common'
 import { SSMParameterReaderProps } from './types'
 
 /**
- * @stability stable
- * @category cdk-utils.ssm-manager
- * @subcategory Construct
  * @classdesc Provides operations on AWS Systems Manager.
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
@@ -21,7 +18,6 @@ import { SSMParameterReaderProps } from './types'
  *     this.acmManager.writeStringToParameters('MyParameter', this, ...props)
  *   }
  * }
- *
  * @see [CDK Systems Manager Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm-readme.html}
  */
 export class SsmManager {
@@ -29,16 +25,16 @@ export class SsmManager {
 
   /**
    * Method to write a string parameter to the parameters store
-   * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {ssm.StringParameterProps} props parameter props
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param props parameter props
    */
   public writeStringToParameters(id: string, scope: CommonConstruct, props: ssm.StringParameterProps) {
     if (!props) throw `Parameter props undefined for ${id}`
 
     const parameter = new ssm.StringParameter(scope, `${id}`, {
-      parameterName: `${props.parameterName}-${scope.props.stage}`,
       description: `${props.description} - ${scope.props.stage} stage`,
+      parameterName: `${props.parameterName}-${scope.props.stage}`,
       stringValue: props.stringValue,
     })
 
@@ -50,9 +46,9 @@ export class SsmManager {
 
   /**
    * Method to read a string parameter from the parameters store
-   * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {string} parameterName parameter name to lookup
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param parameterName parameter name to lookup
    */
   public readStringParameter(id: string, scope: CommonConstruct, parameterName: string) {
     if (!parameterName || parameterName == '') throw 'Invalid parameter name'
@@ -62,10 +58,10 @@ export class SsmManager {
 
   /**
    * Method to read a string parameter from the parameters store in a given region
-   * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {string} parameterName parameter name to lookup
-   * @param {string} region region name to lookup parameter
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param parameterName parameter name to lookup
+   * @param region region name to lookup parameter
    */
   public readStringParameterFromRegion(id: string, scope: CommonConstruct, parameterName: string, region: string) {
     if (!parameterName || parameterName == '') throw `Invalid parameter name for ${id}`
@@ -79,8 +75,6 @@ export class SsmManager {
 }
 
 /**
- * @category cdk-utils.ssm-manager
- * @subcategory Construct
  * @classdesc Provides utilities to read same/cross region SSM parameters
  */
 export class SSMParameterReader extends cr.AwsCustomResource {
@@ -88,13 +82,13 @@ export class SSMParameterReader extends cr.AwsCustomResource {
     const { parameterName, region } = props
 
     const ssmAwsSdkCall: cr.AwsSdkCall = {
-      service: 'SSM',
       action: 'getParameter',
       parameters: {
         Name: `${parameterName}-${scope.props.stage}`,
       },
-      region,
       physicalResourceId: cr.PhysicalResourceId.of(Date.now().toString()),
+      region,
+      service: 'SSM',
     }
 
     super(scope, name, {

package/src/lib/services/aws/systems-manager/types.ts

@@ -1,6 +1,4 @@
 /**
- * @category cdk-utils.ssm-manager
- * @subcategory Properties
  */
 export interface SSMParameterReaderProps {
   parameterName: string

package/src/lib/services/aws/virtual-private-cloud/main.ts

@@ -4,15 +4,10 @@ import * as utils from '../../../utils'
 import { CommonConstruct } from '../../../common'
 
 /**
- * @stability stable
- * @category cdk-utils.vpc-manager
- * @subcategory Construct
  */
 const CommonVpcIdentifier = 'CommonVpc'
 
 /**
- * @category cdk-utils.vpc-manager
- * @subcategory Construct
  * @classdesc Provides operations on AWS VPC.
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
@@ -26,21 +21,20 @@ const CommonVpcIdentifier = 'CommonVpc'
  *     this.vpcManager.createVpc('MyVPC', this)
  *   }
  * }
- *
  * @see [CDK VPC Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.@aws-cdk_aws-ec2.Vpc.html}
  */
 export class VpcManager {
   /**
    * @summary Method to create a new vpc
-   * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {ec2.VpcProps} props
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param props
    */
   public createVpc(id: string, scope: CommonConstruct, props: ec2.VpcProps) {
     if (!props) throw `Vpc props undefined for ${id}`
     const vpc = new ec2.Vpc(scope, `${id}`, {
-      maxAzs: props.maxAzs,
       ipAddresses: props.ipAddresses,
+      maxAzs: props.maxAzs,
     })
 
     utils.createCfnOutput(`${id}Id`, scope, vpc.vpcId)
@@ -64,9 +58,9 @@ export class VpcManager {
 
   /**
    * @summary Method to create a common vpc
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {ec2.VpcProps} props
-   * @param {string?} vpcIdentifier optional identifier for VPC
+   * @param scope scope in which this resource is defined
+   * @param props
+   * @param vpcIdentifier optional identifier for VPC
    */
   public createCommonVpc(scope: CommonConstruct, props: ec2.VpcProps, vpcIdentifier?: string) {
     const vpc = this.createVpc(CommonVpcIdentifier, scope, props)
@@ -77,9 +71,9 @@ export class VpcManager {
 
   /**
    * @summary Method to retrieve a common vpc
-   * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {string?} vpcIdentifier optional identifier for VPC
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param vpcIdentifier optional identifier for VPC
    */
   public retrieveCommonVpc(id: string, scope: CommonConstruct, vpcIdentifier?: string) {
     return ec2.Vpc.fromLookup(scope, `${id}`, { vpcName: vpcIdentifier ?? CommonVpcIdentifier })

package/src/lib/services/aws/web-application-firewall/index.ts

@@ -1 +1,2 @@
 export * from './main'
+export * from './types'

package/src/lib/services/aws/web-application-firewall/main.ts

@@ -4,9 +4,6 @@ import { CommonConstruct } from '../../../common'
 import { WafIPSetProps, WafWebACLProps } from './types'
 
 /**
- * @stability stable
- * @category cdk-utils.waf-manager
- * @subcategory Construct
  * @classdesc Provides operations on AWS WAF.
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
@@ -20,24 +17,23 @@ import { WafIPSetProps, WafWebACLProps } from './types'
  *     this.wafManager.createWebAcl('MyWebAcl', this)
  *   }
  * }
- *
  * @see [CDK WAF Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_waf-readme.html}
  */
 export class WafManager {
   /**
    * @summary Method to create an ip set
-   * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {WafIPSetProps} props
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param props
    */
   public createIpSet(id: string, scope: CommonConstruct, props: WafIPSetProps) {
     if (!props) throw `WAF Ip Set props undefined for ${id}`
 
     const ipSet = new wafv2.CfnIPSet(scope, `${id}`, {
-      name: scope.isProductionStage() ? props.name : `${props.name}-${scope.props.stage}`,
-      description: `IP Set for ${id} - ${scope.props.stage} stage`,
       addresses: props.addresses,
+      description: `IP Set for ${id} - ${scope.props.stage} stage`,
       ipAddressVersion: props.ipAddressVersion,
+      name: scope.isProductionStage() ? props.name : `${props.name}-${scope.props.stage}`,
       scope: props.scope,
     })
 
@@ -49,21 +45,21 @@ export class WafManager {
 
   /**
    * @summary Method to create a web acl
-   * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {WafWebACLProps} props
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param props
    */
   public createWebAcl(id: string, scope: CommonConstruct, props: WafWebACLProps) {
     if (!props) throw `WAF WebACL props undefined for ${id}`
 
     const webAcl = new wafv2.CfnWebACL(scope, `${id}`, {
-      name: scope.isProductionStage() ? props.name : `${props.name}-${scope.props.stage}`,
-      description: `Web Acl for ${id} - ${scope.props.stage} stage`,
       defaultAction: props.defaultAction,
-      scope: props.scope,
-      visibilityConfig: props.visibilityConfig,
+      description: `Web Acl for ${id} - ${scope.props.stage} stage`,
+      name: scope.isProductionStage() ? props.name : `${props.name}-${scope.props.stage}`,
       rules: props.rules,
+      scope: props.scope,
       tags: [{ key: 'service', value: scope.props.name }],
+      visibilityConfig: props.visibilityConfig,
     })
 
     utils.createCfnOutput(`${id}-webAclId`, scope, webAcl.attrId)

package/src/lib/services/aws/web-application-firewall/types.ts

@@ -1,13 +1,9 @@
 import { CfnIPSetProps, CfnWebACLProps } from 'aws-cdk-lib/aws-wafv2'
 
 /**
- * @category cdk-utils.waf-manager
- * @subcategory Properties
  */
 export interface WafIPSetProps extends CfnIPSetProps {}
 
 /**
- * @category cdk-utils.waf-manager
- * @subcategory Properties
  */
 export interface WafWebACLProps extends CfnWebACLProps {}

package/src/lib/types/aws/index.ts

@@ -1,6 +1,4 @@
 /**
- * @category cdk-utils.common-stack
- * @subcategory Properties
  */
 export interface TagProps {
   key: string

package/src/lib/utils/aws/index.ts

@@ -3,16 +3,13 @@ import * as _ from 'lodash'
 import { CommonConstruct } from '../../common'
 
 /**
- * @category cdk-utils.utils
  * @summary Helper method to add CloudFormation outputs from the construct
- * @param {string} id scoped id of the resource
- * @param {CommonConstruct} scope scope in which this resource is defined
- * @param {string} id scoped id of the resource
- * @param {string} value the value of the exported output
- * @param {string?} description optional description for the output
- * @param {boolean} overrideId Flag which indicates whether to override the default logical id of the output
- *
- * @return {cdk.CfnOutput} The CloudFormation output
+ * @param id scoped id of the resource
+ * @param scope scope in which this resource is defined
+ * @param value the value of the exported output
+ * @param description optional description for the output
+ * @param overrideId Flag which indicates whether to override the default logical id of the output
+ * @returns The CloudFormation output
  */
 export function createCfnOutput(
   id: string,
@@ -23,9 +20,9 @@ export function createCfnOutput(
 ): cdk.CfnOutput {
   const camelName = _.camelCase(id)
   const output = new cdk.CfnOutput(scope, id, {
+    description,
     exportName: `${scope.props.stackName}-${camelName}`,
     value: value ?? '',
-    description,
   })
   if (overrideId) {
     output.overrideLogicalId(camelName)

package/src/lib/utils/index.ts

@@ -1,19 +1,17 @@
 export * from './aws'
 
 /**
- * @category cdk-utils.utils
  */
 const defaultResponseObject = {
-  statusCode: 200,
   body: '',
-  isBase64Encoded: false,
   headers: {
     'Access-Control-Allow-Origin': '*',
   },
+  isBase64Encoded: false,
+  statusCode: 200,
 }
 
 /**
- * @category cdk-utils.utils
  */
 export enum LogLevel {
   DEBUG = 'DEBUG',
@@ -25,45 +23,39 @@ export enum LogLevel {
 }
 
 /**
- * @category cdk-utils.utils
  * @param stage
  */
 export const isDevStage = (stage: string) => stage === 'dev'
 /**
- * @category cdk-utils.utils
  * @param stage
  */
 export const isTestStage = (stage: string) => stage === 'tst'
 /**
- * @category cdk-utils.utils
  * @param stage
  */
 export const isUatStage = (stage: string) => stage === 'uat'
 /**
- * @category cdk-utils.utils
  * @param stage
  */
 export const isPrdStage = (stage: string) => stage === 'prd'
 
 /**
- * @category cdk-utils.utils
  * @param error
  */
 export function redirectError(error: any) {
   console.error(error, error.message, error.stack)
   return Object.assign({}, defaultResponseObject, {
+    body: JSON.stringify(Object.assign({}, { error: error.message, success: false })),
     statusCode: 500,
-    body: JSON.stringify(Object.assign({}, { success: false, error: error.message })),
   })
 }
 
 /**
- * @category cdk-utils.utils
  * @param message
  */
 export function redirectSuccess(message: any) {
   return Object.assign({}, defaultResponseObject, {
+    body: JSON.stringify(Object.assign({}, { error: message, success: true })),
     statusCode: 200,
-    body: JSON.stringify(Object.assign({}, { success: true, error: message })),
   })
 }