@gradientedge/cdk-utils-aws 2.5.0 → 2.6.0

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

@@ -1,5 +1,10 @@
 import * as ec2 from 'aws-cdk-lib/aws-ec2';
+/**
+ * Properties for configuring an AWS VPC.
+ * @see [CDK VPC Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2-readme.html}
+ */
 /** @category Interface */
 export interface VpcProps extends ec2.VpcProps {
+    /** Whether to create an IPv6-native VPC with dual-stack subnets */
     isIPV6?: boolean;
 }

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

@@ -1,10 +1,14 @@
 import { CfnIPSetProps, CfnWebACLProps } from 'aws-cdk-lib/aws-wafv2';
 /**
+ * Properties for configuring a WAF IP set.
+ * @see [CDK WAFv2 Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_wafv2-readme.html}
  */
 /** @category Interface */
 export interface WafIPSetProps extends CfnIPSetProps {
 }
 /**
+ * Properties for configuring a WAF Web ACL.
+ * @see [CDK WAFv2 Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_wafv2-readme.html}
  */
 /** @category Interface */
 export interface WafWebACLProps extends CfnWebACLProps {

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

@@ -1,7 +1,10 @@
 /**
+ * Represents a key-value pair used for tagging AWS resources
  */
 /** @category Interface */
 export interface TagProps {
+    /** The tag key */
     key: string;
+    /** The tag value */
     value: string;
 }

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

@@ -13,12 +13,16 @@ import { CommonConstruct } from '../common/index.js';
 /** @category Constant */
 export declare function createCfnOutput(id: string, scope: CommonConstruct, value?: string, description?: string, overrideId?: boolean): CfnOutput;
 /**
- *
+ * @summary Determine the AWS credentials provider based on the environment
+ * Uses profile-based credentials when AWS_PROFILE is set, otherwise falls back to environment variables
+ * @returns The resolved AWS credential identity provider
  */
 /** @category Constant */
 export declare function determineCredentials(): AwsCredentialIdentityProvider;
 /**
- * @param error
+ * @summary Format an error into a Lambda proxy response with a 500 status code
+ * @param error the error object to format and log
+ * @returns A Lambda proxy response object with the error message and 500 status
  */
 /** @category Constant */
 export declare function redirectError(error: any): {
@@ -33,7 +37,9 @@ export declare function redirectError(error: any): {
     statusCode: number;
 };
 /**
- * @param message
+ * @summary Format a success message into a Lambda proxy response with a 200 status code
+ * @param message the success message to include in the response body
+ * @returns A Lambda proxy response object with the message and 200 status
  */
 /** @category Constant */
 export declare function redirectSuccess(message: any): {

package/dist/src/utils/index.js

@@ -24,7 +24,9 @@ export function createCfnOutput(id, scope, value, description, overrideId = true
     return output;
 }
 /**
- *
+ * @summary Determine the AWS credentials provider based on the environment
+ * Uses profile-based credentials when AWS_PROFILE is set, otherwise falls back to environment variables
+ * @returns The resolved AWS credential identity provider
  */
 /** @category Constant */
 export function determineCredentials() {
@@ -33,6 +35,7 @@ export function determineCredentials() {
     return fromEnv();
 }
 /**
+ * Default API Gateway Lambda proxy response object with CORS headers enabled
  */
 const defaultResponseObject = {
     body: '',
@@ -43,7 +46,9 @@ const defaultResponseObject = {
     statusCode: 200,
 };
 /**
- * @param error
+ * @summary Format an error into a Lambda proxy response with a 500 status code
+ * @param error the error object to format and log
+ * @returns A Lambda proxy response object with the error message and 500 status
  */
 /** @category Constant */
 export function redirectError(error) {
@@ -54,7 +59,9 @@ export function redirectError(error) {
     });
 }
 /**
- * @param message
+ * @summary Format a success message into a Lambda proxy response with a 200 status code
+ * @param message the success message to include in the response body
+ * @returns A Lambda proxy response object with the message and 200 status
  */
 /** @category Constant */
 export function redirectSuccess(message) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/cdk-utils-aws",
-  "version": "2.5.0",
+  "version": "2.6.0",
   "description": "AWS CDK utilities for @gradientedge/cdk-utils",
   "type": "module",
   "main": "dist/src/index.js",
@@ -24,7 +24,7 @@
     "constructs": "10.6.0",
     "moment": "2.30.1",
     "uuid": "14.0.0",
-    "@gradientedge/cdk-utils-common": "2.2.1"
+    "@gradientedge/cdk-utils-common": "2.3.0"
   },
   "keywords": [
     "gradientedge",