@gradientedge/cdk-utils-aws 2.0.0 → 2.1.0

package/dist/src/services/step-function/types.d.ts

@@ -2,87 +2,103 @@ import { ChoiceProps, FailProps, MapProps, ParallelProps, PassProps, RetryProps,
 import { CallApiGatewayRestApiEndpointProps, DynamoDeleteItemProps, DynamoGetItemProps, DynamoPutItemProps, LambdaInvokeProps, SqsSendMessageProps, StepFunctionsStartExecutionProps } from 'aws-cdk-lib/aws-stepfunctions-tasks';
 /**
  */
+/** @category Interface */
 export interface SfnSucceedProps extends SucceedProps {
     name: string;
 }
 /**
  */
+/** @category Interface */
 export interface SfnRetryProps extends RetryProps {
     intervalInSecs: number;
 }
 /**
  */
+/** @category Interface */
 export interface SfnFailProps extends FailProps {
     name: string;
 }
 /**
  */
+/** @category Interface */
 export interface SfnPassProps extends PassProps {
     name: string;
 }
 /**
  */
+/** @category Interface */
 export interface SfnDynamoGetItemProps extends DynamoGetItemProps {
     name: string;
     retries?: SfnRetryProps[];
 }
 /**
  */
+/** @category Interface */
 export interface SfnDynamoPutItemProps extends DynamoPutItemProps {
     name: string;
     retries?: SfnRetryProps[];
 }
 /**
  */
+/** @category Interface */
 export interface SfnDynamoDeleteItemProps extends DynamoDeleteItemProps {
     name: string;
     retries?: SfnRetryProps[];
 }
 /**
  */
+/** @category Interface */
 export interface SfnSqsSendMessageProps extends SqsSendMessageProps {
     name: string;
     retries?: SfnRetryProps[];
 }
 /**
  */
+/** @category Interface */
 export interface SfnParallelProps extends ParallelProps {
     name: string;
     retries?: SfnRetryProps[];
 }
 /**
  */
+/** @category Interface */
 export interface SfnChoiceProps extends ChoiceProps {
     name: string;
 }
 /**
  */
+/** @category Interface */
 export interface SfnWaitProps extends WaitProps {
     name: string;
     delayInSeconds: number;
 }
 /**
  */
+/** @category Interface */
 export interface SfnLambdaInvokeProps extends LambdaInvokeProps {
     name: string;
     retries?: SfnRetryProps[];
 }
 /**
  */
+/** @category Interface */
 export interface SfnCallApiGatewayRestApiEndpointProps extends CallApiGatewayRestApiEndpointProps {
     name: string;
     retries?: SfnRetryProps[];
 }
 /**
  */
+/** @category Interface */
 export interface SfnStateMachineProps extends StateMachineProps {
 }
 /**
  */
+/** @category Interface */
 export interface SfnMapProps extends MapProps {
 }
 /**
  */
+/** @category Interface */
 export interface SfnStartExecutionProps extends StepFunctionsStartExecutionProps {
     retries?: SfnRetryProps[];
 }

package/dist/src/services/systems-manager/main.d.ts

@@ -3,7 +3,7 @@ import { AwsCustomResource } from 'aws-cdk-lib/custom-resources';
 import { CommonConstruct } from '../../common/index.js';
 import { SSMParameterReaderProps, SSMStringParameterProps } from './types.js';
 /**
- * @classdesc Provides operations on AWS Systems Manager.
+ * 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.
  * @example
@@ -17,6 +17,7 @@ import { SSMParameterReaderProps, SSMStringParameterProps } from './types.js';
  *   }
  * }
  * @see [CDK Systems Manager Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm-readme.html}
+ * @category Service
  */
 export declare class SsmManager {
     static SECRETS_MODIFIED_TIMESTAMP_PARAM: string;
@@ -44,7 +45,8 @@ export declare class SsmManager {
     readStringParameterFromRegion(id: string, scope: CommonConstruct, parameterName: string, region: string): string;
 }
 /**
- * @classdesc Provides utilities to read same/cross region SSM parameters
+ * Provides utilities to read same/cross region SSM parameters
+ * @category Service
  */
 export declare class SSMParameterReader extends AwsCustomResource {
     constructor(scope: CommonConstruct, name: string, props: SSMParameterReaderProps);

package/dist/src/services/systems-manager/main.js

@@ -2,7 +2,7 @@ import { StringParameter } from 'aws-cdk-lib/aws-ssm';
 import { AwsCustomResource, AwsCustomResourcePolicy, PhysicalResourceId, } from 'aws-cdk-lib/custom-resources';
 import { createCfnOutput } from '../../utils/index.js';
 /**
- * @classdesc Provides operations on AWS Systems Manager.
+ * 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.
  * @example
@@ -16,6 +16,7 @@ import { createCfnOutput } from '../../utils/index.js';
  *   }
  * }
  * @see [CDK Systems Manager Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm-readme.html}
+ * @category Service
  */
 export class SsmManager {
     static SECRETS_MODIFIED_TIMESTAMP_PARAM = 'secrets-last-modified-timestamp';
@@ -69,7 +70,8 @@ export class SsmManager {
     }
 }
 /**
- * @classdesc Provides utilities to read same/cross region SSM parameters
+ * Provides utilities to read same/cross region SSM parameters
+ * @category Service
  */
 export class SSMParameterReader extends AwsCustomResource {
     constructor(scope, name, props) {

package/dist/src/services/systems-manager/types.d.ts

@@ -1,9 +1,11 @@
 import { StringParameterProps } from 'aws-cdk-lib/aws-ssm';
 /**
  */
+/** @category Interface */
 export interface SSMParameterReaderProps {
     parameterName: string;
     region: string;
 }
+/** @category Interface */
 export interface SSMStringParameterProps extends StringParameterProps {
 }

package/dist/src/services/virtual-private-cloud/ipv6.d.ts

@@ -1,6 +1,7 @@
 import { Vpc } from 'aws-cdk-lib/aws-ec2';
 import { CommonConstruct } from '../../common/index.js';
 import { VpcProps } from './types.js';
+/** @category Service */
 export declare class Ipv6Vpc extends Vpc {
     egressOnlyInternetGatewayId: string;
     constructor(scope: CommonConstruct, id: string, props: VpcProps);

package/dist/src/services/virtual-private-cloud/ipv6.js

@@ -1,6 +1,7 @@
 import { Fn } from 'aws-cdk-lib';
 import { CfnEgressOnlyInternetGateway, CfnVPCCidrBlock, RouterType, Vpc, } from 'aws-cdk-lib/aws-ec2';
 import _ from 'lodash';
+/** @category Service */
 export class Ipv6Vpc extends Vpc {
     egressOnlyInternetGatewayId;
     constructor(scope, id, props) {

package/dist/src/services/virtual-private-cloud/main.d.ts

@@ -2,7 +2,7 @@ import { Vpc } from 'aws-cdk-lib/aws-ec2';
 import { CommonConstruct } from '../../common/index.js';
 import { VpcProps } from './types.js';
 /**
- * @classdesc Provides operations on AWS VPC.
+ * 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.
  * @example
@@ -16,6 +16,7 @@ import { VpcProps } from './types.js';
  *   }
  * }
  * @see [CDK VPC Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.@aws-cdk_aws-Vpc.html}
+ * @category Service
  */
 export declare class VpcManager {
     /**

package/dist/src/services/virtual-private-cloud/main.js

@@ -7,7 +7,7 @@ import { Ipv6Vpc } from './ipv6.js';
  */
 const CommonVpcIdentifier = 'CommonVpc';
 /**
- * @classdesc Provides operations on AWS VPC.
+ * 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.
  * @example
@@ -21,6 +21,7 @@ const CommonVpcIdentifier = 'CommonVpc';
  *   }
  * }
  * @see [CDK VPC Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.@aws-cdk_aws-Vpc.html}
+ * @category Service
  */
 export class VpcManager {
     /**

package/dist/src/services/virtual-private-cloud/types.d.ts

@@ -1,4 +1,5 @@
 import * as ec2 from 'aws-cdk-lib/aws-ec2';
+/** @category Interface */
 export interface VpcProps extends ec2.VpcProps {
     isIPV6?: boolean;
 }

package/dist/src/services/web-application-firewall/main.d.ts

@@ -2,7 +2,7 @@ import { CfnIPSet, CfnWebACL } from 'aws-cdk-lib/aws-wafv2';
 import { CommonConstruct } from '../../common/index.js';
 import { WafIPSetProps, WafWebACLProps } from './types.js';
 /**
- * @classdesc Provides operations on AWS WAF.
+ * 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.
  * @example
@@ -16,6 +16,7 @@ import { WafIPSetProps, WafWebACLProps } from './types.js';
  *   }
  * }
  * @see [CDK WAF Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_waf-readme.html}
+ * @category Service
  */
 export declare class WafManager {
     /**

package/dist/src/services/web-application-firewall/main.js

@@ -1,7 +1,7 @@
 import { CfnIPSet, CfnWebACL } from 'aws-cdk-lib/aws-wafv2';
 import { createCfnOutput } from '../../utils/index.js';
 /**
- * @classdesc Provides operations on AWS WAF.
+ * 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.
  * @example
@@ -15,6 +15,7 @@ import { createCfnOutput } from '../../utils/index.js';
  *   }
  * }
  * @see [CDK WAF Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_waf-readme.html}
+ * @category Service
  */
 export class WafManager {
     /**

package/dist/src/services/web-application-firewall/types.d.ts

@@ -1,9 +1,11 @@
 import { CfnIPSetProps, CfnWebACLProps } from 'aws-cdk-lib/aws-wafv2';
 /**
  */
+/** @category Interface */
 export interface WafIPSetProps extends CfnIPSetProps {
 }
 /**
  */
+/** @category Interface */
 export interface WafWebACLProps extends CfnWebACLProps {
 }

package/dist/src/types/index.d.ts

@@ -1,5 +1,6 @@
 /**
  */
+/** @category Interface */
 export interface TagProps {
     key: string;
     value: string;

package/dist/src/utils/index.d.ts

@@ -10,14 +10,17 @@ import { CommonConstruct } from '../common/index.js';
  * @param overrideId Flag which indicates whether to override the default logical id of the output
  * @returns The CloudFormation output
  */
+/** @category Constant */
 export declare function createCfnOutput(id: string, scope: CommonConstruct, value?: string, description?: string, overrideId?: boolean): CfnOutput;
 /**
  *
  */
+/** @category Constant */
 export declare function determineCredentials(): AwsCredentialIdentityProvider;
 /**
  * @param error
  */
+/** @category Constant */
 export declare function redirectError(error: any): {
     body: string;
     headers: {
@@ -32,6 +35,7 @@ export declare function redirectError(error: any): {
 /**
  * @param message
  */
+/** @category Constant */
 export declare function redirectSuccess(message: any): {
     body: string;
     headers: {

package/dist/src/utils/index.js

@@ -10,6 +10,7 @@ import _ from 'lodash';
  * @param overrideId Flag which indicates whether to override the default logical id of the output
  * @returns The CloudFormation output
  */
+/** @category Constant */
 export function createCfnOutput(id, scope, value, description, overrideId = true) {
     const camelName = _.camelCase(id);
     const output = new CfnOutput(scope, id, {
@@ -25,6 +26,7 @@ export function createCfnOutput(id, scope, value, description, overrideId = true
 /**
  *
  */
+/** @category Constant */
 export function determineCredentials() {
     if (process.env.AWS_PROFILE)
         return fromIni();
@@ -43,6 +45,7 @@ const defaultResponseObject = {
 /**
  * @param error
  */
+/** @category Constant */
 export function redirectError(error) {
     console.error(error, error.message, error.stack);
     return Object.assign({}, defaultResponseObject, {
@@ -53,6 +56,7 @@ export function redirectError(error) {
 /**
  * @param message
  */
+/** @category Constant */
 export function redirectSuccess(message) {
     return Object.assign({}, defaultResponseObject, {
         body: JSON.stringify(Object.assign({}, { error: message, success: true })),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/cdk-utils-aws",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "AWS CDK utilities for @gradientedge/cdk-utils",
   "type": "module",
   "main": "dist/src/index.js",
@@ -14,18 +14,26 @@
     "dist/src/"
   ],
   "dependencies": {
-    "@aws-sdk/client-secrets-manager": "3.1022.0",
-    "@aws-sdk/credential-providers": "3.1022.0",
+    "@aws-sdk/client-secrets-manager": "3.1025.0",
+    "@aws-sdk/credential-providers": "3.1025.0",
     "@aws-sdk/types": "3.973.6",
     "@types/lodash": "4.17.24",
     "app-root-path": "3.1.0",
-    "aws-cdk-lib": "2.247.0",
+    "aws-cdk-lib": "2.248.0",
     "lodash": "4.18.1",
     "constructs": "10.6.0",
     "moment": "2.30.1",
     "uuid": "13.0.0",
-    "@gradientedge/cdk-utils-common": "2.0.0"
+    "@gradientedge/cdk-utils-common": "2.1.0"
   },
+  "keywords": [
+    "gradientedge",
+    "aws",
+    "cdk",
+    "aws-cdk",
+    "iac",
+    "typescript"
+  ],
   "publishConfig": {
     "access": "public"
   },
@@ -35,6 +43,10 @@
     "url": "git+https://github.com/gradientedge/cdk-utils.git",
     "directory": "packages/aws"
   },
+  "typedocOptions": {
+    "gitRevision": "main",
+    "sourceLinkTemplate": "https://github.com/gradientedge/cdk-utils/blob/main/{path}#L{line}"
+  },
   "scripts": {
     "build": "tsc",
     "build:production": "tsc -p tsconfig.prd.json",