@gradientedge/cdk-utils 8.90.0 → 8.92.0

package/dist/src/lib/services/aws/codebuild/main.js

@@ -27,9 +27,6 @@ exports.CodeBuildManager = void 0;
 const cdk = __importStar(require("aws-cdk-lib"));
 const codebuild = __importStar(require("aws-cdk-lib/aws-codebuild"));
 /**
- * @stability stable
- * @category cdk-utils.codebuild-manager
- * @subcategory Construct
  * @classdesc Provides operations on AWS Code Build.
  * - 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.
@@ -43,7 +40,6 @@ const codebuild = __importStar(require("aws-cdk-lib/aws-codebuild"));
  *     this.codeBuildManager.createImageForCloudfrontInvalidation('MyInvalidation', this, './docker ')
  *   }
  * }
- *
  * @see [CDK Codebuild Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild-readme.html}
  */
 class CodeBuildManager {
@@ -67,9 +63,7 @@ class CodeBuildManager {
     createProjectForCloudfrontInvalidation(id, scope, dockerFilepath, distributionId, paths) {
         const invalidationPaths = paths ?? '/*';
         return new codebuild.Project(scope, `${id}-install-deps-project`, {
-            role: scope.iamManager.roleForCloudfrontInvalidation(id, scope),
             buildSpec: codebuild.BuildSpec.fromObject({
-                version: '0.1',
                 phases: {
                     build: {
                         commands: [
@@ -77,6 +71,7 @@ class CodeBuildManager {
                         ],
                     },
                 },
+                version: '0.1',
             }),
             environment: {
                 buildImage: codebuild.LinuxBuildImage.fromDockerRegistry(this.createImageForCloudfrontInvalidation(id, scope, dockerFilepath).imageUri),
@@ -85,12 +80,13 @@ class CodeBuildManager {
             },
             logging: {
                 cloudWatch: {
+                    enabled: true,
                     logGroup: scope.logManager.createLogGroup(`${id}-project-log-group`, scope, {
                         logGroupName: `${id}-cloudfront-invalidation`,
                     }),
-                    enabled: true,
                 },
             },
+            role: scope.iamManager.roleForCloudfrontInvalidation(id, scope),
             timeout: cdk.Duration.minutes(5),
         });
     }

package/dist/src/lib/services/aws/dynamodb/main.d.ts

@@ -2,9 +2,6 @@ import * as dynamodb from 'aws-cdk-lib/aws-dynamodb';
 import { CommonConstruct } from '../../../common';
 import { TableProps } from './types';
 /**
- * @stability stable
- * @category cdk-utils.dynamodb-manager
- * @subcategory Construct
  * @classdesc Provides operations on AWS DynamoDB.
  * - 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.
@@ -18,15 +15,14 @@ import { TableProps } from './types';
  *     this.dynamodbManager.createTable('MyTable', this, tableProps)
  *   }
  * }
- *
  * @see [CDK Certificate Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_dynamodb-readme.html}
  */
 export declare class DynamodbManager {
     /**
      * @summary Method to create a table
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {TableProps} props table props
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props table props
      */
     createTable(id: string, scope: CommonConstruct, props: TableProps): dynamodb.Table;
 }

package/dist/src/lib/services/aws/dynamodb/main.js

@@ -28,9 +28,6 @@ const dynamodb = __importStar(require("aws-cdk-lib/aws-dynamodb"));
 const utils = __importStar(require("../../../utils"));
 const cdk = __importStar(require("aws-cdk-lib"));
 /**
- * @stability stable
- * @category cdk-utils.dynamodb-manager
- * @subcategory Construct
  * @classdesc Provides operations on AWS DynamoDB.
  * - 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.
@@ -44,37 +41,36 @@ const cdk = __importStar(require("aws-cdk-lib"));
  *     this.dynamodbManager.createTable('MyTable', this, tableProps)
  *   }
  * }
- *
  * @see [CDK Certificate Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_dynamodb-readme.html}
  */
 class DynamodbManager {
     /**
      * @summary Method to create a table
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {TableProps} props table props
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props table props
      */
     createTable(id, scope, props) {
         if (!props)
             throw `Table props undefined for ${id}`;
         const table = new dynamodb.Table(scope, `${id}`, {
-            tableName: `${props.tableName}-${scope.props.stage}`,
-            partitionKey: props.partitionKey,
-            sortKey: props.sortKey,
-            kinesisStream: props.kinesisStream,
-            readCapacity: props.readCapacity,
-            writeCapacity: props.writeCapacity,
             billingMode: props.billingMode,
-            pointInTimeRecovery: props.pointInTimeRecovery,
+            contributorInsightsEnabled: props.contributorInsightsEnabled,
             encryption: props.encryption,
             encryptionKey: props.encryptionKey,
-            timeToLiveAttribute: props.timeToLiveAttribute,
-            stream: props.stream,
+            kinesisStream: props.kinesisStream,
+            partitionKey: props.partitionKey,
+            pointInTimeRecovery: props.pointInTimeRecovery,
+            readCapacity: props.readCapacity,
             removalPolicy: props.removalPolicy,
             replicationRegions: props.replicationRegions,
             replicationTimeout: props.replicationTimeout,
+            sortKey: props.sortKey,
+            stream: props.stream,
+            tableName: `${props.tableName}-${scope.props.stage}`,
+            timeToLiveAttribute: props.timeToLiveAttribute,
             waitForReplicationToFinish: props.waitForReplicationToFinish,
-            contributorInsightsEnabled: props.contributorInsightsEnabled,
+            writeCapacity: props.writeCapacity,
         });
         if (props.tags && props.tags.length > 0) {
             props.tags.forEach(tag => {

package/dist/src/lib/services/aws/dynamodb/types.d.ts

@@ -1,8 +1,6 @@
 import * as dynamodb from 'aws-cdk-lib/aws-dynamodb';
 import { TagProps } from '../../../types';
 /**
- * @category cdk-utils.dynamodb-manager
- * @subcategory Properties
  */
 export interface TableProps extends dynamodb.TableProps {
     tags?: TagProps[];

package/dist/src/lib/services/aws/elastic-container-registry/main.d.ts

@@ -1,9 +1,6 @@
 import * as ecr from 'aws-cdk-lib/aws-ecr-assets';
 import { CommonConstruct } from '../../../common';
 /**
- * @stability stable
- * @category cdk-utils.ecr-manager
- * @subcategory Construct
  * @classdesc Provides operations on AWS Elastic Container Registry.
  * - 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.
@@ -17,15 +14,14 @@ import { CommonConstruct } from '../../../common';
  *     this.ecrManager.createDockerImage('MyImage', this, dockerfilePath)
  *   }
  * }
- *
  * @see [CDK ECR Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecr-readme.html}
  */
 export declare class EcrManager {
     /**
      * @summary Method to create a docker image in ecr
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {string} dockerfilePath
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param dockerfilePath
      */
     createDockerImage(id: string, scope: CommonConstruct, dockerfilePath: string): ecr.DockerImageAsset;
 }

package/dist/src/lib/services/aws/elastic-container-registry/main.js

@@ -27,9 +27,6 @@ exports.EcrManager = void 0;
 const ecr = __importStar(require("aws-cdk-lib/aws-ecr-assets"));
 const utils = __importStar(require("../../../utils"));
 /**
- * @stability stable
- * @category cdk-utils.ecr-manager
- * @subcategory Construct
  * @classdesc Provides operations on AWS Elastic Container Registry.
  * - 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.
@@ -43,15 +40,14 @@ const utils = __importStar(require("../../../utils"));
  *     this.ecrManager.createDockerImage('MyImage', this, dockerfilePath)
  *   }
  * }
- *
  * @see [CDK ECR Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecr-readme.html}
  */
 class EcrManager {
     /**
      * @summary Method to create a docker image in ecr
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {string} dockerfilePath
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param dockerfilePath
      */
     createDockerImage(id, scope, dockerfilePath) {
         const asset = new ecr.DockerImageAsset(scope, `${id}`, {

package/dist/src/lib/services/aws/elastic-container-service/main.d.ts

@@ -6,9 +6,6 @@ import * as logs from 'aws-cdk-lib/aws-logs';
 import { CommonConstruct } from '../../../common';
 import { EcsApplicationLoadBalancedFargateServiceProps, EcsClusterProps, EcsTaskProps } from './types';
 /**
- * @stability stable
- * @category cdk-utils.ecs-manager
- * @subcategory Construct
  * @classdesc Provides operations on AWS Elastic Container Service.
  * - 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.
@@ -22,39 +19,38 @@ import { EcsApplicationLoadBalancedFargateServiceProps, EcsClusterProps, EcsTask
  *     this.ecsManager.createEcsCluster('MyCluster', this, vpc)
  *   }
  * }
- *
  * @see [CDK ECS Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs-readme.html}
  */
 export declare class EcsManager {
     /**
      * @summary Method to create an ecs cluster
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {EcsClusterProps} props
-     * @param {ec2.IVpc} vpc
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param vpc
      */
     createEcsCluster(id: string, scope: CommonConstruct, props: EcsClusterProps, vpc: ec2.IVpc): cdk.aws_ecs.Cluster;
     /**
      * @summary Method to create an ecs fargate task
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {EcsTaskProps} props
-     * @param {ecs.ICluster} cluster
-     * @param {iam.Role} role
-     * @param {logs.ILogGroup} logGroup
-     * @param {ecs.ContainerImage} containerImage
-     * @param {Map<string, string>} environment
-     * @param {Map<string, string>} secrets
-     * @param {string[]} command
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param cluster
+     * @param role
+     * @param logGroup
+     * @param containerImage
+     * @param environment
+     * @param secrets
+     * @param command
      */
     createEcsFargateTask(id: string, scope: CommonConstruct, props: EcsTaskProps, cluster: ecs.ICluster, role: iam.Role, logGroup: logs.ILogGroup, containerImage: ecs.ContainerImage, environment?: any, secrets?: any, command?: string[]): cdk.aws_ecs.TaskDefinition;
     /**
      * @summary Method to create an application loadbalanced ecs fargate task
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {EcsApplicationLoadBalancedFargateServiceProps} props
-     * @param {ecs.ICluster} cluster
-     * @param {logs.ILogGroup} logGroup
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param cluster
+     * @param logGroup
      */
     createLoadBalancedFargateService(id: string, scope: CommonConstruct, props: EcsApplicationLoadBalancedFargateServiceProps, cluster: ecs.ICluster, logGroup: logs.ILogGroup): cdk.aws_ecs_patterns.ApplicationLoadBalancedFargateService;
 }

package/dist/src/lib/services/aws/elastic-container-service/main.js

@@ -29,9 +29,6 @@ const ecs = __importStar(require("aws-cdk-lib/aws-ecs"));
 const ecsPatterns = __importStar(require("aws-cdk-lib/aws-ecs-patterns"));
 const utils = __importStar(require("../../../utils"));
 /**
- * @stability stable
- * @category cdk-utils.ecs-manager
- * @subcategory Construct
  * @classdesc Provides operations on AWS Elastic Container Service.
  * - 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.
@@ -45,28 +42,27 @@ const utils = __importStar(require("../../../utils"));
  *     this.ecsManager.createEcsCluster('MyCluster', this, vpc)
  *   }
  * }
- *
  * @see [CDK ECS Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs-readme.html}
  */
 class EcsManager {
     /**
      * @summary Method to create an ecs cluster
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {EcsClusterProps} props
-     * @param {ec2.IVpc} vpc
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param vpc
      */
     createEcsCluster(id, scope, props, vpc) {
         if (!props)
             throw `Ecs Cluster props undefined for ${id}`;
         const ecsCluster = new ecs.Cluster(scope, `${id}`, {
+            capacity: props.capacity,
             clusterName: `${props.clusterName}-${scope.props.stage}`,
-            vpc: vpc,
+            containerInsights: props.containerInsights,
             defaultCloudMapNamespace: props.defaultCloudMapNamespace,
-            capacity: props.capacity,
             enableFargateCapacityProviders: props.enableFargateCapacityProviders,
-            containerInsights: props.containerInsights,
             executeCommandConfiguration: props.executeCommandConfiguration,
+            vpc: vpc,
         });
         if (props.tags && props.tags.length > 0) {
             props.tags.forEach(tag => {
@@ -79,16 +75,16 @@ class EcsManager {
     }
     /**
      * @summary Method to create an ecs fargate task
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {EcsTaskProps} props
-     * @param {ecs.ICluster} cluster
-     * @param {iam.Role} role
-     * @param {logs.ILogGroup} logGroup
-     * @param {ecs.ContainerImage} containerImage
-     * @param {Map<string, string>} environment
-     * @param {Map<string, string>} secrets
-     * @param {string[]} command
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param cluster
+     * @param role
+     * @param logGroup
+     * @param containerImage
+     * @param environment
+     * @param secrets
+     * @param command
      */
     createEcsFargateTask(id, scope, props, cluster, role, logGroup, containerImage, environment, secrets, command) {
         if (!props)
@@ -99,35 +95,35 @@ class EcsManager {
             ephemeralStorageGiB: props.ephemeralStorageGiB,
             executionRole: role,
             family: `${props.family}-${scope.props.stage}`,
-            ipcMode: props.ipcMode,
             inferenceAccelerators: props.inferenceAccelerators,
+            ipcMode: props.ipcMode,
             memoryMiB: props.memoryMiB,
             networkMode: ecs.NetworkMode.AWS_VPC,
             pidMode: props.pidMode,
             placementConstraints: props.placementConstraints,
             proxyConfiguration: props.proxyConfiguration,
             runtimePlatform: {
-                operatingSystemFamily: props.runtimePlatform?.operatingSystemFamily ?? ecs.OperatingSystemFamily.LINUX,
                 cpuArchitecture: props.runtimePlatform?.cpuArchitecture ?? ecs.CpuArchitecture.X86_64,
+                operatingSystemFamily: props.runtimePlatform?.operatingSystemFamily ?? ecs.OperatingSystemFamily.LINUX,
             },
             taskRole: role,
             volumes: props.volumes,
         });
         ecsTask.addContainer('EcsContainer', {
+            command: command,
             cpu: props.cpu ? parseInt(props.cpu) : undefined,
             disableNetworking: false,
             environment: environment,
             image: containerImage,
             logging: ecs.LogDriver.awsLogs({
                 logGroup: logGroup,
-                streamPrefix: `${id}`,
-                multilinePattern: props.logging?.multilinePattern,
                 logRetention: props.logging?.logRetention,
+                multilinePattern: props.logging?.multilinePattern,
+                streamPrefix: `${id}`,
             }),
             memoryLimitMiB: props.memoryMiB ? parseInt(props.memoryMiB) : undefined,
             privileged: false,
             secrets: secrets,
-            command: command,
         });
         if (props.tags && props.tags.length > 0) {
             props.tags.forEach(tag => {
@@ -139,11 +135,11 @@ class EcsManager {
     }
     /**
      * @summary Method to create an application loadbalanced ecs fargate task
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {EcsApplicationLoadBalancedFargateServiceProps} props
-     * @param {ecs.ICluster} cluster
-     * @param {logs.ILogGroup} logGroup
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param cluster
+     * @param logGroup
      */
     createLoadBalancedFargateService(id, scope, props, cluster, logGroup) {
         if (!props)
@@ -164,25 +160,25 @@ class EcsManager {
             loadBalancerName: `${id}-${scope.props.stage}`,
             memoryLimitMiB: props.memoryLimitMiB,
             runtimePlatform: {
-                operatingSystemFamily: props.runtimePlatform?.operatingSystemFamily ?? ecs.OperatingSystemFamily.LINUX,
                 cpuArchitecture: props.runtimePlatform?.cpuArchitecture ?? ecs.CpuArchitecture.X86_64,
+                operatingSystemFamily: props.runtimePlatform?.operatingSystemFamily ?? ecs.OperatingSystemFamily.LINUX,
             },
             serviceName: `${id}-${scope.props.stage}`,
             taskImageOptions: {
+                containerPort: props.taskImageOptions?.containerPort,
                 enableLogging: props.taskImageOptions?.enableLogging ?? true,
+                environment: props.taskImageOptions?.environment,
+                executionRole: props.taskImageOptions?.executionRole,
+                image: props.taskImageOptions.image,
                 logDriver: props.taskImageOptions?.logDriver ??
                     ecs.LogDriver.awsLogs({
                         logGroup: logGroup,
-                        streamPrefix: `${id}-${scope.props.stage}/ecs`,
-                        multilinePattern: props.logging?.multilinePattern,
                         logRetention: props.logging?.logRetention,
+                        multilinePattern: props.logging?.multilinePattern,
+                        streamPrefix: `${id}-${scope.props.stage}/ecs`,
                     }),
-                image: props.taskImageOptions.image,
-                executionRole: props.taskImageOptions?.executionRole,
-                taskRole: props.taskImageOptions?.taskRole,
-                containerPort: props.taskImageOptions?.containerPort,
-                environment: props.taskImageOptions?.environment,
                 secrets: props.taskImageOptions?.secrets,
+                taskRole: props.taskImageOptions?.taskRole,
             },
         });
         if (props.healthCheck) {

package/dist/src/lib/services/aws/elastic-container-service/types.d.ts

@@ -4,39 +4,31 @@ import { ScalingSchedule } from 'aws-cdk-lib/aws-applicationautoscaling';
 import { ApplicationLoadBalancedFargateServiceProps } from 'aws-cdk-lib/aws-ecs-patterns';
 import * as elb from 'aws-cdk-lib/aws-elasticloadbalancingv2';
 /**
- * @category cdk-utils.ecs-manager
- * @subcategory Properties
  */
 export interface EcsClusterProps extends ClusterProps {
     tags?: TagProps[];
 }
 /**
- * @category cdk-utils.ecs-manager
- * @subcategory Properties
  */
 export interface EcsTaskProps extends TaskDefinitionProps {
     logging?: AwsLogDriverProps;
     tags?: TagProps[];
 }
 export interface EcsScalingProps {
-    minCapacity?: number;
     maxCapacity?: number;
+    minCapacity?: number;
     scaleOnCpuUtilization?: number;
     scaleOnMemoryUtilization?: number;
     scaleOnRequestsPerTarget?: number;
     scaleOnSchedule?: ScalingSchedule;
 }
 /**
- * @category cdk-utils.site-with-ecs-backend
- * @subcategory Properties
  */
 export interface HealthCheck extends elb.HealthCheck {
     intervalInSecs: number;
     timeoutInSecs: number;
 }
 /**
- * @category cdk-utils.ecs-manager
- * @subcategory Properties
  */
 export interface EcsApplicationLoadBalancedFargateServiceProps extends ApplicationLoadBalancedFargateServiceProps {
     healthCheck?: HealthCheck;

package/dist/src/lib/services/aws/elastic-file-system/main.d.ts

@@ -3,18 +3,15 @@ import * as efs from 'aws-cdk-lib/aws-efs';
 import { CommonConstruct } from '../../../common';
 import { EfsAccessPointOptions, EfsFileSystemProps } from './types';
 export declare const DEFAULT_CREATE_ACL: {
-    ownerUid: string;
     ownerGid: string;
+    ownerUid: string;
     permissions: string;
 };
 export declare const DEFAULT_POSIX_USER: {
-    uid: string;
     gid: string;
+    uid: string;
 };
 /**
- * @stability stable
- * @category cdk-utils.efs-manager
- * @subcategory Construct
  * @classdesc Provides operations on AWS Elastic File System.
  * - 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.
@@ -28,19 +25,18 @@ export declare const DEFAULT_POSIX_USER: {
  *     this.efsManager.createFileSystem('MyFileSystem', this, fileSystemProps, vpc)
  *   }
  * }
- *
  * @see [CDK EFS Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_efs-readme.html}
  */
 export declare class EfsManager {
     /**
      * @summary Method to create an efs file system
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {EfsFileSystemProps} props the file system props
-     * @param {ec2.IVpc} vpc the vpc to use for the file system
-     * @param {EfsAccessPointOptions[]} accessPointOptions optional access point configuration options for the file system
-     * @param {ec2.ISecurityGroup} securityGroup optional security groups to configure for the file system
-     * @param {ec2.SubnetSelection} vpcSubnets optional subnets to configure for the file system
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props the file system props
+     * @param vpc the vpc to use for the file system
+     * @param accessPointOptions optional access point configuration options for the file system
+     * @param securityGroup optional security groups to configure for the file system
+     * @param vpcSubnets optional subnets to configure for the file system
      */
     createFileSystem(id: string, scope: CommonConstruct, props: EfsFileSystemProps, vpc: ec2.IVpc, accessPointOptions?: EfsAccessPointOptions[], securityGroup?: ec2.ISecurityGroup, vpcSubnets?: ec2.SubnetSelection): efs.FileSystem;
 }

package/dist/src/lib/services/aws/elastic-file-system/main.js

@@ -28,18 +28,15 @@ const efs = __importStar(require("aws-cdk-lib/aws-efs"));
 const cdk = __importStar(require("aws-cdk-lib"));
 const utils = __importStar(require("../../../utils"));
 exports.DEFAULT_CREATE_ACL = {
-    ownerUid: '1000',
     ownerGid: '1000',
+    ownerUid: '1000',
     permissions: '755',
 };
 exports.DEFAULT_POSIX_USER = {
-    uid: '1000',
     gid: '1000',
+    uid: '1000',
 };
 /**
- * @stability stable
- * @category cdk-utils.efs-manager
- * @subcategory Construct
  * @classdesc Provides operations on AWS Elastic File System.
  * - 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.
@@ -53,19 +50,18 @@ exports.DEFAULT_POSIX_USER = {
  *     this.efsManager.createFileSystem('MyFileSystem', this, fileSystemProps, vpc)
  *   }
  * }
- *
  * @see [CDK EFS Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_efs-readme.html}
  */
 class EfsManager {
     /**
      * @summary Method to create an efs file system
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {EfsFileSystemProps} props the file system props
-     * @param {ec2.IVpc} vpc the vpc to use for the file system
-     * @param {EfsAccessPointOptions[]} accessPointOptions optional access point configuration options for the file system
-     * @param {ec2.ISecurityGroup} securityGroup optional security groups to configure for the file system
-     * @param {ec2.SubnetSelection} vpcSubnets optional subnets to configure for the file system
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props the file system props
+     * @param vpc the vpc to use for the file system
+     * @param accessPointOptions optional access point configuration options for the file system
+     * @param securityGroup optional security groups to configure for the file system
+     * @param vpcSubnets optional subnets to configure for the file system
      */
     createFileSystem(id, scope, props, vpc, accessPointOptions, securityGroup, vpcSubnets) {
         if (!props)
@@ -73,14 +69,14 @@ class EfsManager {
         const fileSystemId = props.provisionNewOnDeployment ? `${id}-${new Date().getMilliseconds()}` : `${id}`;
         const fileSystem = new efs.FileSystem(scope, `${fileSystemId}`, {
             ...props,
-            vpc,
-            securityGroup,
-            vpcSubnets,
             fileSystemName: props.fileSystemName ? `${props.fileSystemName}-${scope.props.stage}` : undefined,
             lifecyclePolicy: props.lifecyclePolicy ?? efs.LifecyclePolicy.AFTER_7_DAYS,
-            performanceMode: props.performanceMode ?? efs.PerformanceMode.GENERAL_PURPOSE,
             outOfInfrequentAccessPolicy: props.outOfInfrequentAccessPolicy ?? efs.OutOfInfrequentAccessPolicy.AFTER_1_ACCESS,
+            performanceMode: props.performanceMode ?? efs.PerformanceMode.GENERAL_PURPOSE,
             removalPolicy: props.removalPolicy ?? cdk.RemovalPolicy.DESTROY,
+            securityGroup,
+            vpc,
+            vpcSubnets,
         });
         utils.createCfnOutput(`${id}-fileSystemArn`, scope, fileSystem.fileSystemArn);
         utils.createCfnOutput(`${id}-fileSystemId`, scope, fileSystem.fileSystemId);
@@ -90,8 +86,8 @@ class EfsManager {
                 if (!accessPointOption.path)
                     throw `Undefined access point path for option: [${accessPointOption}], id: [${id}]`;
                 const accessPoint = fileSystem.addAccessPoint(`${id}-ap-${index}`, {
-                    path: accessPointOption.path,
                     createAcl: accessPointOption.createAcl ?? exports.DEFAULT_CREATE_ACL,
+                    path: accessPointOption.path,
                     posixUser: accessPointOption.posixUser ?? exports.DEFAULT_POSIX_USER,
                 });
                 utils.createCfnOutput(`${id}-accessPointArn-${index}`, scope, accessPoint.accessPointArn);

package/dist/src/lib/services/aws/elastic-file-system/types.d.ts

@@ -1,19 +1,15 @@
 import { AccessPointOptions, FileSystemProps } from 'aws-cdk-lib/aws-efs';
 import { AuthorizationConfig } from 'aws-cdk-lib/aws-ecs';
 /**
- * @category cdk-utils.efs-manager
- * @subcategory Properties
  */
 export interface EfsFileSystemProps extends FileSystemProps {
+    authorizationConfig?: AuthorizationConfig;
     provisionNewOnDeployment?: boolean;
     rootDirectory?: string;
     transitEncryption?: string;
     transitEncryptionPort?: number;
-    authorizationConfig?: AuthorizationConfig;
 }
 /**
- * @category cdk-utils.efs-manager
- * @subcategory Properties
  */
 export interface EfsAccessPointOptions extends AccessPointOptions {
 }