@gradientedge/cdk-utils-aws 2.5.0 → 2.6.0

package/dist/src/services/lambda/types.d.ts

@@ -8,54 +8,88 @@ import { QueueProps } from '../simple-queue-service/index.js';
  */
 /** @category Interface */
 export interface EdgeFunctionProps extends FunctionProps {
+    /** Optional stack ID for the edge function's dedicated stack */
     readonly stackId?: string;
 }
 /**
+ * Properties for configuring provisioned concurrency auto-scaling on a Lambda alias.
  */
 /** @category Interface */
 export interface ProvisionedConcurrencyProps {
+    /** Maximum number of provisioned concurrency instances to scale out to */
     maxCapacity: number;
+    /** Minimum number of provisioned concurrency instances to maintain */
     minCapacity: number;
+    /** Target utilization percentage to trigger scaling (0-1) */
     utilizationTarget: number;
 }
 /**
+ * Properties for creating a Lambda function.
+ * @see {@link FunctionProps}
  */
 /** @category Interface */
 export interface LambdaProps extends FunctionProps {
+    /** Optional dead letter queue configuration for failed invocations */
     dlq?: QueueProps;
+    /** When true, excludes the last modified timestamp from asset hashing */
     excludeLastModifiedTimestamp?: boolean;
+    /** Optional list of aliases to create for the function */
     lambdaAliases?: LambdaAliasProps[];
+    /** The log level to set as an environment variable */
     logLevel?: string;
+    /** Log retention period in days */
     logRetentionInDays?: number;
+    /** Optional redrive queue configuration for reprocessing failed messages */
     redriveq?: QueueProps;
+    /** Optional tags to apply to the Lambda function */
     tags?: TagProps[];
+    /** Function timeout in seconds, defaults to 15 minutes */
     timeoutInSecs?: number;
 }
 /**
+ * Properties for creating a Lambda function alias with optional provisioned concurrency.
+ * @see {@link AliasProps}
  */
 /** @category Interface */
 export interface LambdaAliasProps extends AliasProps {
+    /** Optional custom logical ID for the alias resource */
     id?: string;
+    /** Optional provisioned concurrency auto-scaling configuration */
     provisionedConcurrency?: ProvisionedConcurrencyProps;
 }
 /**
+ * Properties for creating a Lambda@Edge function.
+ * @see {@link EdgeFunctionProps}
  */
 /** @category Interface */
 export interface LambdaEdgeProps extends EdgeFunctionProps {
+    /** Optional tags to apply to the edge function */
     tags?: TagProps[];
+    /** Function timeout in seconds, defaults to 1 minute */
     timeoutInSecs?: number;
 }
 /**
+ * Standard environment variables injected into Lambda functions.
  */
 /** @category Interface */
 export interface LambdaEnvironment {
+    /** The application log level (e.g. 'debug', 'info', 'warn', 'error') */
     LOG_LEVEL: string;
+    /** The Node.js environment (e.g. 'production', 'development') */
     NODE_ENV: string;
+    /** Optional AWS region override */
     REGION?: string;
+    /** Optional deployment stage (e.g. 'dev', 'staging', 'prod') */
     STAGE?: string;
+    /** The timezone for the function runtime */
     TZ: string;
 }
+/**
+ * Properties for configuring an SQS event source for a Lambda function.
+ * @see {@link SqsEventSourceProps}
+ */
 /** @category Interface */
 export interface SQSEventSourceProps extends SqsEventSourceProps {
+    /** The maximum batching window in seconds before invoking the function */
     maxBatchingWindowInSecs: number;
 }

package/dist/src/services/route53/main.js

@@ -81,6 +81,8 @@ export class Route53Manager {
             throw new Error(`Distribution undefined for ${id}`);
         if (!hostedZone)
             throw new Error(`HostedZone undefined for ${id}`);
+        /* In production or when skipStageFromRecord is set, use the plain record name;
+           otherwise append the stage suffix for environment isolation */
         const aRecord = new ARecord(scope, `${id}`, {
             recordName: (recordName && scope.isProductionStage()) || skipStageFromRecord
                 ? `${recordName}`

package/dist/src/services/route53/types.d.ts

@@ -1,7 +1,10 @@
 import { HostedZoneProps } from 'aws-cdk-lib/aws-route53';
 /**
+ * Properties for configuring an AWS Route53 hosted zone.
+ * @see [CDK Route53 Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_route53-readme.html}
  */
 /** @category Interface */
 export interface Route53Props extends HostedZoneProps {
+    /** Whether to look up an existing hosted zone instead of creating a new one */
     useExistingHostedZone?: boolean;
 }

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

@@ -56,6 +56,7 @@ export class SecretsManager {
      * @param secretKey the secret key to resolve the value for
      */
     async resolveSecretValue(region, secretId, secretKey) {
+        /* Create an SDK client using the credentials resolved from the environment/profile */
         const client = new SecretsManagerClient({
             credentials: determineCredentials(),
             region,
@@ -66,6 +67,7 @@ export class SecretsManager {
         const response = await client.send(command);
         if (!response.SecretString)
             throw new Error(`Unable to resolve secret for ${secretId}`);
+        /* Parse the secret JSON string and extract the requested key */
         const secretString = JSON.parse(response.SecretString);
         return secretString[secretKey];
     }

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

@@ -1,4 +1,8 @@
 import { SecretProps } from 'aws-cdk-lib/aws-secretsmanager';
+/**
+ * Properties for configuring an AWS Secrets Manager secret.
+ * @see [CDK Secrets Manager Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_secretsmanager-readme.html}
+ */
 /** @category Interface */
 export interface SecretBaseProps extends SecretProps {
 }

package/dist/src/services/simple-notification-service/types.d.ts

@@ -1,5 +1,7 @@
 import { TopicProps } from 'aws-cdk-lib/aws-sns';
 /**
+ * Properties for configuring an AWS SNS topic subscription.
+ * @see [CDK SNS Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sns-readme.html}
  */
 /** @category Interface */
 export interface SubscriptionProps extends TopicProps {

package/dist/src/services/simple-queue-service/main.js

@@ -86,6 +86,8 @@ export class SqsManager {
      * @param deadLetterQueue
      */
     createDeadLetterQueueForLambda(id, scope, props, deadLetterQueue) {
+        /* Merge any DLQ-specific config from the lambda props, falling back to
+           a minimal config with just the queue name derived from the function name */
         let queueProps;
         if (props.dlq) {
             queueProps = {

package/dist/src/services/simple-queue-service/types.d.ts

@@ -1,16 +1,27 @@
 import * as sqs from 'aws-cdk-lib/aws-sqs';
 import { TagProps } from '../../types/index.js';
 /**
+ * Properties for configuring an AWS SQS queue.
+ * @see [CDK SQS Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs-readme.html}
  */
 /** @category Interface */
 export interface QueueProps extends sqs.QueueProps {
+    /** Duration in seconds for which the data key is reused before calling KMS again */
     dataKeyReuseInSecs?: number;
+    /** Delay in seconds before messages become visible after being sent */
     deliveryDelayInSecs?: number;
+    /** Maximum number of times a message can be received before being sent to the dead letter queue */
     maxReceiveCount?: number;
+    /** Duration in seconds for which a receive call waits for a message to arrive */
     receiveMessageWaitTimeInSecs?: number;
+    /** Number of days the queue retains messages */
     retentionInDays?: number;
+    /** Whether retries are enabled for the dead letter queue */
     retriesEnabled?: boolean;
+    /** Batch size for retry processing from the dead letter queue */
     retryBatchSize?: number;
+    /** Tags to apply to the queue */
     tags?: TagProps[];
+    /** Duration in seconds that a received message is hidden from subsequent receive requests */
     visibilityTimeoutInSecs?: number;
 }

package/dist/src/services/simple-storage-service/main.d.ts

@@ -70,7 +70,7 @@ export declare class S3Manager {
      */
     doBucketDeployment(id: string, scope: CommonConstruct, siteBucket: IBucket, distribution: IDistribution, sources: ISource[], prefix: string, prune?: boolean): void;
     /**
-     *
+     * @summary Method to create placeholder folders in an S3 bucket
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
      * @param bucket bucket to create the folders in

package/dist/src/services/simple-storage-service/main.js

@@ -88,10 +88,12 @@ export class S3Manager {
             throw new Error(`S3 props undefined for ${id}`);
         let bucket;
         const bucketName = S3Manager.determineBucketName(scope, props, props.bucketName);
+        /* Import an existing bucket by name instead of creating a new one */
         if (props.existingBucket && props.bucketName) {
             bucket = Bucket.fromBucketName(scope, `${id}`, S3Manager.determineBucketName(scope, props, props.bucketName));
         }
         else {
+            /* Optionally look up a separate bucket for server access logging */
             let logBucket;
             if (props.logBucketName) {
                 logBucket = Bucket.fromBucketName(scope, `${id}-logs`, S3Manager.determineBucketName(scope, props, props.logBucketName));
@@ -105,6 +107,8 @@ export class S3Manager {
                 removalPolicy: props.removalPolicy || RemovalPolicy.RETAIN,
                 serverAccessLogsBucket: logBucket,
             });
+            /* Enable EventBridge notifications at the L1 (CloudFormation) level,
+               since the L2 Bucket construct does not expose this setting directly */
             const cfnBucket = bucket.node.defaultChild;
             cfnBucket.notificationConfiguration = {
                 eventBridgeConfiguration: {
@@ -174,7 +178,7 @@ export class S3Manager {
         });
     }
     /**
-     *
+     * @summary Method to create placeholder folders in an S3 bucket
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
      * @param bucket bucket to create the folders in

package/dist/src/services/simple-storage-service/types.d.ts

@@ -2,27 +2,43 @@ import * as s3 from 'aws-cdk-lib/aws-s3';
 import * as s3deploy from 'aws-cdk-lib/aws-s3-deployment';
 import { TagProps } from '../../types/index.js';
 /**
+ * Properties for configuring an S3 bucket lifecycle rule with convenience duration fields.
+ * @see [CDK S3 Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3-readme.html}
  */
 /** @category Interface */
 export interface LifecycleRule extends s3.LifecycleRule {
+    /** Number of days after which objects expire */
     expirationInDays?: number;
+    /** Number of days after which noncurrent object versions expire */
     noncurrentVersionExpirationInDays?: number;
 }
 /**
+ * Properties for configuring an S3 bucket deployment with convenience duration fields.
+ * @see [CDK S3 Deployment Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3_deployment-readme.html}
  */
 /** @category Interface */
 export interface BucketDeploymentProps extends s3deploy.BucketDeploymentProps {
+    /** Number of days after which objects expire */
     expirationInDays?: number;
+    /** Number of days after which noncurrent object versions expire */
     noncurrentVersionExpirationInDays?: number;
 }
 /**
+ * Properties for configuring an AWS S3 bucket.
+ * @see [CDK S3 Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3-readme.html}
  */
 /** @category Interface */
 export interface S3BucketProps extends s3.BucketProps {
+    /** The name of the S3 bucket */
     bucketName: string;
+    /** Whether to enable EventBridge notifications for bucket events */
     enableEventBridge?: boolean;
+    /** Whether to reference an existing bucket rather than creating a new one */
     existingBucket?: boolean;
+    /** Lifecycle rules for objects in the bucket */
     lifecycleRules?: LifecycleRule[];
+    /** Name of an existing bucket to use for server access logging */
     logBucketName?: string;
+    /** Tags to apply to the bucket */
     tags?: TagProps[];
 }

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

@@ -1,104 +1,158 @@
 import { ChoiceProps, FailProps, MapProps, ParallelProps, PassProps, RetryProps, StateMachineProps, SucceedProps, WaitProps } from 'aws-cdk-lib/aws-stepfunctions';
 import { CallApiGatewayRestApiEndpointProps, DynamoDeleteItemProps, DynamoGetItemProps, DynamoPutItemProps, LambdaInvokeProps, SqsSendMessageProps, StepFunctionsStartExecutionProps } from 'aws-cdk-lib/aws-stepfunctions-tasks';
 /**
+ * Properties for configuring a Step Functions succeed state.
+ * @see [CDK Step Functions Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions-readme.html}
  */
 /** @category Interface */
 export interface SfnSucceedProps extends SucceedProps {
+    /** The name of the step */
     name: string;
 }
 /**
+ * Properties for configuring retry behaviour on a Step Functions step.
+ * @see [CDK Step Functions Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions-readme.html}
  */
 /** @category Interface */
 export interface SfnRetryProps extends RetryProps {
+    /** Interval in seconds between retries */
     intervalInSecs: number;
 }
 /**
+ * Properties for configuring a Step Functions fail state.
+ * @see [CDK Step Functions Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions-readme.html}
  */
 /** @category Interface */
 export interface SfnFailProps extends FailProps {
+    /** The name of the step */
     name: string;
 }
 /**
+ * Properties for configuring a Step Functions pass state.
+ * @see [CDK Step Functions Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions-readme.html}
  */
 /** @category Interface */
 export interface SfnPassProps extends PassProps {
+    /** The name of the step */
     name: string;
 }
 /**
+ * Properties for configuring a DynamoDB GetItem step in a Step Functions workflow.
+ * @see [CDK Step Functions Tasks Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks-readme.html}
  */
 /** @category Interface */
 export interface SfnDynamoGetItemProps extends DynamoGetItemProps {
+    /** The name of the step */
     name: string;
+    /** Retry configuration for the step */
     retries?: SfnRetryProps[];
 }
 /**
+ * Properties for configuring a DynamoDB PutItem step in a Step Functions workflow.
+ * @see [CDK Step Functions Tasks Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks-readme.html}
  */
 /** @category Interface */
 export interface SfnDynamoPutItemProps extends DynamoPutItemProps {
+    /** The name of the step */
     name: string;
+    /** Retry configuration for the step */
     retries?: SfnRetryProps[];
 }
 /**
+ * Properties for configuring a DynamoDB DeleteItem step in a Step Functions workflow.
+ * @see [CDK Step Functions Tasks Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks-readme.html}
  */
 /** @category Interface */
 export interface SfnDynamoDeleteItemProps extends DynamoDeleteItemProps {
+    /** The name of the step */
     name: string;
+    /** Retry configuration for the step */
     retries?: SfnRetryProps[];
 }
 /**
+ * Properties for configuring an SQS SendMessage step in a Step Functions workflow.
+ * @see [CDK Step Functions Tasks Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks-readme.html}
  */
 /** @category Interface */
 export interface SfnSqsSendMessageProps extends SqsSendMessageProps {
+    /** The name of the step */
     name: string;
+    /** Retry configuration for the step */
     retries?: SfnRetryProps[];
 }
 /**
+ * Properties for configuring a Step Functions parallel state.
+ * @see [CDK Step Functions Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions-readme.html}
  */
 /** @category Interface */
 export interface SfnParallelProps extends ParallelProps {
+    /** The name of the step */
     name: string;
+    /** Retry configuration for the step */
     retries?: SfnRetryProps[];
 }
 /**
+ * Properties for configuring a Step Functions choice state.
+ * @see [CDK Step Functions Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions-readme.html}
  */
 /** @category Interface */
 export interface SfnChoiceProps extends ChoiceProps {
+    /** The name of the step */
     name: string;
 }
 /**
+ * Properties for configuring a Step Functions wait state.
+ * @see [CDK Step Functions Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions-readme.html}
  */
 /** @category Interface */
 export interface SfnWaitProps extends WaitProps {
+    /** The name of the step */
     name: string;
+    /** Delay in seconds before proceeding to the next state */
     delayInSeconds: number;
 }
 /**
+ * Properties for configuring a Lambda invoke step in a Step Functions workflow.
+ * @see [CDK Step Functions Tasks Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks-readme.html}
  */
 /** @category Interface */
 export interface SfnLambdaInvokeProps extends LambdaInvokeProps {
+    /** The name of the step */
     name: string;
+    /** Retry configuration for the step */
     retries?: SfnRetryProps[];
 }
 /**
+ * Properties for configuring an API Gateway REST API endpoint call step in a Step Functions workflow.
+ * @see [CDK Step Functions Tasks Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks-readme.html}
  */
 /** @category Interface */
 export interface SfnCallApiGatewayRestApiEndpointProps extends CallApiGatewayRestApiEndpointProps {
+    /** The name of the step */
     name: string;
+    /** Retry configuration for the step */
     retries?: SfnRetryProps[];
 }
 /**
+ * Properties for configuring a Step Functions state machine.
+ * @see [CDK Step Functions Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions-readme.html}
  */
 /** @category Interface */
 export interface SfnStateMachineProps extends StateMachineProps {
 }
 /**
+ * Properties for configuring a Step Functions map state.
+ * @see [CDK Step Functions Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions-readme.html}
  */
 /** @category Interface */
 export interface SfnMapProps extends MapProps {
 }
 /**
+ * Properties for configuring a Step Functions start execution step.
+ * @see [CDK Step Functions Tasks Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks-readme.html}
  */
 /** @category Interface */
 export interface SfnStartExecutionProps extends StepFunctionsStartExecutionProps {
+    /** Retry configuration for the step */
     retries?: SfnRetryProps[];
 }

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

@@ -20,23 +20,24 @@ import { SSMParameterReaderProps, SSMStringParameterProps } from './types.js';
  * @category Service
  */
 export declare class SsmManager {
+    /** Parameter name used to store the last-modified timestamp for secrets */
     static SECRETS_MODIFIED_TIMESTAMP_PARAM: string;
     /**
-     * Method to write a string parameter to the parameters store
+     * @summary Method to write a string parameter to the parameters store
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
      * @param props parameter props
      */
     writeStringToParameters(id: string, scope: CommonConstruct, props: SSMStringParameterProps): StringParameter;
     /**
-     * Method to read a string parameter from the parameters store
+     * @summary Method to read a string parameter from the parameters store
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
      * @param parameterName parameter name to lookup
      */
     readStringParameter(id: string, scope: CommonConstruct, parameterName: string): string;
     /**
-     * Method to read a string parameter from the parameters store in a given region
+     * @summary Method to read a string parameter from the parameters store in a given region
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
      * @param parameterName parameter name to lookup
@@ -45,10 +46,20 @@ export declare class SsmManager {
     readStringParameterFromRegion(id: string, scope: CommonConstruct, parameterName: string, region: string): string;
 }
 /**
- * Provides utilities to read same/cross region SSM parameters
+ * Provides utilities to read same/cross region SSM parameters.
+ *
+ * Uses an {@link AwsCustomResource} backed by the SSM SDK to read
+ * parameters from any region, including cross-region lookups that
+ * the standard CDK SSM constructs do not support.
  * @category Service
  */
 export declare class SSMParameterReader extends AwsCustomResource {
+    /**
+     * @summary Creates a custom resource that reads an SSM parameter
+     * @param scope scope in which this resource is defined
+     * @param name scoped id of the resource
+     * @param props the parameter reader configuration including name and region
+     */
     constructor(scope: CommonConstruct, name: string, props: SSMParameterReaderProps);
     /**
      * @summary Method to retrieve the SSM parameter value from the custom resource response

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

@@ -19,9 +19,10 @@ import { createCfnOutput } from '../../utils/index.js';
  * @category Service
  */
 export class SsmManager {
+    /** Parameter name used to store the last-modified timestamp for secrets */
     static SECRETS_MODIFIED_TIMESTAMP_PARAM = 'secrets-last-modified-timestamp';
     /**
-     * Method to write a string parameter to the parameters store
+     * @summary Method to write a string parameter to the parameters store
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
      * @param props parameter props
@@ -41,7 +42,7 @@ export class SsmManager {
         return parameter;
     }
     /**
-     * Method to read a string parameter from the parameters store
+     * @summary Method to read a string parameter from the parameters store
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
      * @param parameterName parameter name to lookup
@@ -52,7 +53,7 @@ export class SsmManager {
         return StringParameter.valueFromLookup(scope, scope.resourceNameFormatter.format(parameterName, scope.props.resourceNameOptions?.ssm));
     }
     /**
-     * Method to read a string parameter from the parameters store in a given region
+     * @summary Method to read a string parameter from the parameters store in a given region
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
      * @param parameterName parameter name to lookup
@@ -70,12 +71,24 @@ export class SsmManager {
     }
 }
 /**
- * Provides utilities to read same/cross region SSM parameters
+ * Provides utilities to read same/cross region SSM parameters.
+ *
+ * Uses an {@link AwsCustomResource} backed by the SSM SDK to read
+ * parameters from any region, including cross-region lookups that
+ * the standard CDK SSM constructs do not support.
  * @category Service
  */
 export class SSMParameterReader extends AwsCustomResource {
+    /**
+     * @summary Creates a custom resource that reads an SSM parameter
+     * @param scope scope in which this resource is defined
+     * @param name scoped id of the resource
+     * @param props the parameter reader configuration including name and region
+     */
     constructor(scope, name, props) {
         const { parameterName, region } = props;
+        /* Build the SDK call to GetParameter, using a timestamp-based physical
+           resource ID so CloudFormation re-reads the value on every update */
         const ssmAwsSdkCall = {
             action: 'getParameter',
             parameters: {

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

@@ -1,11 +1,19 @@
 import { StringParameterProps } from 'aws-cdk-lib/aws-ssm';
 /**
+ * Properties for reading an SSM parameter, optionally from a cross-region parameter store.
+ * @see [CDK SSM Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm-readme.html}
  */
 /** @category Interface */
 export interface SSMParameterReaderProps {
+    /** The name of the SSM parameter to read */
     parameterName: string;
+    /** The AWS region from which to read the parameter */
     region: string;
 }
+/**
+ * Properties for configuring an AWS Systems Manager string parameter.
+ * @see [CDK SSM Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm-readme.html}
+ */
 /** @category Interface */
 export interface SSMStringParameterProps extends StringParameterProps {
 }

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

@@ -1,8 +1,26 @@
 import { Vpc } from 'aws-cdk-lib/aws-ec2';
 import { CommonConstruct } from '../../common/index.js';
 import { VpcProps } from './types.js';
-/** @category Service */
+/**
+ * A VPC construct that provisions an IPv6-native VPC with dual-stack subnets.
+ *
+ * This construct extends the standard CDK {@link Vpc} to:
+ * - Associate an Amazon-provided IPv6 CIDR block with the VPC
+ * - Convert all subnets (public, private, isolated) to IPv6-native mode
+ * - Add default IPv6 routes via the Internet Gateway (public subnets) and
+ *   an Egress-Only Internet Gateway (private subnets)
+ *
+ * @see [CDK VPC Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2-readme.html}
+ * @category Service
+ */
 export declare class Ipv6Vpc extends Vpc {
+    /** The ID of the egress-only internet gateway created for private subnets */
     egressOnlyInternetGatewayId: string;
+    /**
+     * @summary Creates an IPv6-native VPC with dual-stack subnets
+     * @param scope scope in which this resource is defined
+     * @param id scoped id of the resource
+     * @param props VPC configuration properties
+     */
     constructor(scope: CommonConstruct, id: string, props: VpcProps);
 }

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

@@ -1,16 +1,38 @@
 import { Fn } from 'aws-cdk-lib';
 import { CfnEgressOnlyInternetGateway, CfnVPCCidrBlock, RouterType, Vpc, } from 'aws-cdk-lib/aws-ec2';
 import _ from 'lodash';
-/** @category Service */
+/**
+ * A VPC construct that provisions an IPv6-native VPC with dual-stack subnets.
+ *
+ * This construct extends the standard CDK {@link Vpc} to:
+ * - Associate an Amazon-provided IPv6 CIDR block with the VPC
+ * - Convert all subnets (public, private, isolated) to IPv6-native mode
+ * - Add default IPv6 routes via the Internet Gateway (public subnets) and
+ *   an Egress-Only Internet Gateway (private subnets)
+ *
+ * @see [CDK VPC Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2-readme.html}
+ * @category Service
+ */
 export class Ipv6Vpc extends Vpc {
+    /** The ID of the egress-only internet gateway created for private subnets */
     egressOnlyInternetGatewayId;
+    /**
+     * @summary Creates an IPv6-native VPC with dual-stack subnets
+     * @param scope scope in which this resource is defined
+     * @param id scoped id of the resource
+     * @param props VPC configuration properties
+     */
     constructor(scope, id, props) {
         super(scope, id, props);
+        /* Associate an Amazon-provided IPv6 CIDR block with this VPC */
         const cfnVpcCidrBlock = new CfnVPCCidrBlock(this, `${id}-ipv6-cidr`, {
             amazonProvidedIpv6CidrBlock: true,
             vpcId: this.vpcId,
         });
+        /* Divide the VPC IPv6 CIDR into /64 subnet blocks (max 256 subnets) */
         const subnetIpv6CidrBlocks = Fn.cidr(Fn.select(0, this.vpcIpv6CidrBlocks), 256, '64');
+        /* Convert each subnet to IPv6-native mode: remove IPv4 CIDR, assign an IPv6 CIDR,
+           disable public IPv4 auto-assignment, and enable IPv6 address auto-assignment */
         _.forEach([...this.publicSubnets, ...this.privateSubnets, ...this.isolatedSubnets], (subnet, index) => {
             subnet.node.addDependency(cfnVpcCidrBlock);
             const cfnSubnet = subnet.node.defaultChild;
@@ -20,18 +42,21 @@ export class Ipv6Vpc extends Vpc {
             cfnSubnet.assignIpv6AddressOnCreation = true;
             cfnSubnet.ipv6Native = true;
         });
+        /* Helper to add a default IPv6 route (::/0) to all subnets via the specified gateway */
         const addDefaultIpv6Routes = (subnets, gatewayId, routerType) => subnets.forEach(subnet => subnet.addRoute(`${id}-default-route`, {
             destinationIpv6CidrBlock: '::/0',
             enablesInternetConnectivity: true,
             routerId: gatewayId,
             routerType: routerType,
         }));
+        /* Public subnets route IPv6 traffic through the Internet Gateway */
         if (this.internetGatewayId) {
             addDefaultIpv6Routes(this.publicSubnets, this.internetGatewayId, RouterType.GATEWAY);
         }
         if (_.isEmpty(this.privateSubnets)) {
             return;
         }
+        /* Private subnets use an Egress-Only Internet Gateway for outbound-only IPv6 access */
         const egressIgw = new CfnEgressOnlyInternetGateway(this, `${id}-eigw`, { vpcId: this.vpcId });
         this.egressOnlyInternetGatewayId = egressIgw.ref;
         addDefaultIpv6Routes(this.privateSubnets, egressIgw.ref, RouterType.EGRESS_ONLY_INTERNET_GATEWAY);

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

@@ -3,8 +3,7 @@ import { SubnetType, Vpc } from 'aws-cdk-lib/aws-ec2';
 import _ from 'lodash';
 import { createCfnOutput } from '../../utils/index.js';
 import { Ipv6Vpc } from './ipv6.js';
-/**
- */
+/** Default identifier used for the common/shared VPC when no custom identifier is specified */
 const CommonVpcIdentifier = 'CommonVpc';
 /**
  * Provides operations on AWS VPC.