@gradientedge/cdk-utils 8.91.0 → 8.92.0

package/dist/src/lib/services/aws/secrets-manager/main.d.ts

@@ -3,9 +3,6 @@ import * as cdk from 'aws-cdk-lib';
 import * as secretsManager from 'aws-cdk-lib/aws-secretsmanager';
 import { CommonConstruct } from '../../../common';
 /**
- * @stability experimental
- * @category cdk-utils.secrets-manager
- * @subcategory Construct
  * @classdesc Provides operations on AWS Secrets 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.
@@ -19,31 +16,21 @@ import { CommonConstruct } from '../../../common';
  *     this.secretsManager.loadSecret('MySecretName', 'eu-west-1')
  *   }
  * }
- *
  * @see [CDK Secrets Manager Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_secretsmanager-readme.html}
  */
 export declare class SecretsManager {
     /**
      *
-     * @param {string} region
+     * @param region
      */
     getAwsSecretsManager(region: string): SM;
     /**
-     * @stability experimental
      * @summary Method to load a secret from secrets manager
-     * @param {string} secretName
-     * @param {string} region
+     * @param secretName
+     * @param region
      */
     loadSecret(secretName: string, region: string): Promise<any>;
     /**
-     * @stability experimental
-     * @summary Method to load secrets from secrets manager
-     * @param {string} secretNames
-     * @param {string} region
-     */
-    loadSecrets(secretNames: string, region: string): Promise<{}>;
-    /**
-     * @stability stable
      * @summary Method to retrieve a secret from secrets manager with a cloudformation export
      * @param id
      * @param scope
@@ -53,9 +40,9 @@ export declare class SecretsManager {
     retrieveSecretFromSecretsManager(id: string, scope: CommonConstruct, stackName: string, exportName: string): cdk.aws_secretsmanager.ISecret;
     /**
      * @summary Method to create a secret
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {secretsManager.SecretProps} props the secret properties
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props the secret properties
      */
     createSecret(id: string, scope: CommonConstruct, props: secretsManager.SecretProps): cdk.aws_secretsmanager.Secret;
 }

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

@@ -29,9 +29,6 @@ const cdk = __importStar(require("aws-cdk-lib"));
 const secretsManager = __importStar(require("aws-cdk-lib/aws-secretsmanager"));
 const utils = __importStar(require("../../../utils"));
 /**
- * @stability experimental
- * @category cdk-utils.secrets-manager
- * @subcategory Construct
  * @classdesc Provides operations on AWS Secrets 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.
@@ -45,22 +42,20 @@ const utils = __importStar(require("../../../utils"));
  *     this.secretsManager.loadSecret('MySecretName', 'eu-west-1')
  *   }
  * }
- *
  * @see [CDK Secrets Manager Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_secretsmanager-readme.html}
  */
 class SecretsManager {
     /**
      *
-     * @param {string} region
+     * @param region
      */
     getAwsSecretsManager(region) {
         return new client_secrets_manager_1.SecretsManager({ region: region });
     }
     /**
-     * @stability experimental
      * @summary Method to load a secret from secrets manager
-     * @param {string} secretName
-     * @param {string} region
+     * @param secretName
+     * @param region
      */
     async loadSecret(secretName, region) {
         const secretsManager = this.getAwsSecretsManager(region);
@@ -68,20 +63,6 @@ class SecretsManager {
         return secret ? JSON.parse(secret[0].SecretString) : {};
     }
     /**
-     * @stability experimental
-     * @summary Method to load secrets from secrets manager
-     * @param {string} secretNames
-     * @param {string} region
-     */
-    async loadSecrets(secretNames, region) {
-        let secrets = {};
-        for (const secretName of secretNames.split(',')) {
-            secrets = { ...secrets, ...(await this.loadSecret(secretName, region)) };
-        }
-        return secrets;
-    }
-    /**
-     * @stability stable
      * @summary Method to retrieve a secret from secrets manager with a cloudformation export
      * @param id
      * @param scope
@@ -93,9 +74,9 @@ class SecretsManager {
     }
     /**
      * @summary Method to create a secret
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {secretsManager.SecretProps} props the secret properties
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props the secret properties
      */
     createSecret(id, scope, props) {
         const secret = new secretsManager.Secret(scope, `${id}`, {

package/dist/src/lib/services/aws/simple-notification-service/main.d.ts

@@ -3,9 +3,6 @@ import * as sns from 'aws-cdk-lib/aws-sns';
 import { CommonConstruct } from '../../../common';
 import { SubscriptionProps } from './types';
 /**
- * @stability stable
- * @category cdk-utils.sns-manager
- * @subcategory Construct
  * @classdesc Provides operations on AWS Simple Notification 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.
@@ -19,24 +16,23 @@ import { SubscriptionProps } from './types';
  *     this.snsManager.createEmailNotificationService('MySns', 'eu-west-1', ["test@example.com"])
  *   }
  * }
- *
  * @see [CDK Simple Notification Service Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sns-readme.html}
  */
 export declare class SnsManager {
     /**
      * @summary Method to create an email notification service
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {SubscriptionProps} props
-     * @param {string[]} emails
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param emails
      */
     createEmailNotificationService(id: string, scope: CommonConstruct, props: SubscriptionProps, emails: string[]): sns.Topic;
     /**
      * @summary Method to create a lambda notification service
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {SubscriptionProps} props
-     * @param {lambda.IFunction} lambdaFunction
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param lambdaFunction
      */
     createLambdaNotificationService(id: string, scope: CommonConstruct, props: SubscriptionProps, lambdaFunction: lambda.IFunction): sns.Topic;
 }

package/dist/src/lib/services/aws/simple-notification-service/main.js

@@ -28,9 +28,6 @@ const sns = __importStar(require("aws-cdk-lib/aws-sns"));
 const subs = __importStar(require("aws-cdk-lib/aws-sns-subscriptions"));
 const utils = __importStar(require("../../../utils"));
 /**
- * @stability stable
- * @category cdk-utils.sns-manager
- * @subcategory Construct
  * @classdesc Provides operations on AWS Simple Notification 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.
@@ -44,24 +41,23 @@ const utils = __importStar(require("../../../utils"));
  *     this.snsManager.createEmailNotificationService('MySns', 'eu-west-1', ["test@example.com"])
  *   }
  * }
- *
  * @see [CDK Simple Notification Service Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sns-readme.html}
  */
 class SnsManager {
     /**
      * @summary Method to create an email notification service
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {SubscriptionProps} props
-     * @param {string[]} emails
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param emails
      */
     createEmailNotificationService(id, scope, props, emails) {
         if (!props)
             throw `Subscription props undefined for ${id}`;
         const topic = new sns.Topic(scope, id, {
             displayName: `${props.topicName}-${scope.props.stage}`,
-            topicName: `${props.topicName}-${scope.props.stage}`,
             fifo: props.fifo,
+            topicName: `${props.topicName}-${scope.props.stage}`,
         });
         if (emails && emails.length > 0) {
             emails.forEach((email) => topic.addSubscription(new subs.EmailSubscription(email)));
@@ -72,18 +68,18 @@ class SnsManager {
     }
     /**
      * @summary Method to create a lambda notification service
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {SubscriptionProps} props
-     * @param {lambda.IFunction} lambdaFunction
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param lambdaFunction
      */
     createLambdaNotificationService(id, scope, props, lambdaFunction) {
         if (!props)
             throw `Subscription props undefined for ${id}`;
         const topic = new sns.Topic(scope, id, {
             displayName: `${props.topicName}-${scope.props.stage}`,
-            topicName: `${props.topicName}-${scope.props.stage}`,
             fifo: props.fifo,
+            topicName: `${props.topicName}-${scope.props.stage}`,
         });
         topic.addSubscription(new subs.LambdaSubscription(lambdaFunction));
         utils.createCfnOutput(`${id}-subscriptionArn`, scope, topic.topicArn);

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

@@ -1,7 +1,5 @@
 import { TopicProps } from 'aws-cdk-lib/aws-sns';
 /**
- * @category cdk-utils.sns-manager
- * @subcategory Properties
  */
 export interface SubscriptionProps extends TopicProps {
 }

package/dist/src/lib/services/aws/simple-queue-service/main.d.ts

@@ -4,9 +4,6 @@ import { CommonConstruct } from '../../../common';
 import { QueueProps } from './types';
 import { LambdaProps } from '../lambda';
 /**
- * @stability stable
- * @category cdk-utils.sqs-manager
- * @subcategory Construct
  * @classdesc Provides operations on AWS Simple Queue 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.
@@ -20,31 +17,30 @@ import { LambdaProps } from '../lambda';
  *     this.sqsManager.createQueue('MySqs', this, {...})
  *   }
  * }
- *
  * @see [CDK Simple Queue Service Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs-readme.html}
  */
 export declare class SqsManager {
     /**
      * @summary Method to create a lambda queue service
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {QueueProps} props
-     * @param {sqs.IQueue} deadLetterQueue
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param deadLetterQueue
      */
     createQueue(id: string, scope: CommonConstruct, props: QueueProps, deadLetterQueue?: sqs.IQueue): cdk.aws_sqs.Queue;
     /**
      * @summary Method to create a redrive queue for a lambda function
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {LambdaProps} props the lambda properties
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props the lambda properties
      */
     createRedriveQueueForLambda(id: string, scope: CommonConstruct, props: LambdaProps): cdk.aws_sqs.Queue;
     /**
      * @summary Method to create a dead letter queue for a lambda function
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {LambdaProps} props the lambda properties
-     * @param {sqs.IQueue} deadLetterQueue
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props the lambda properties
+     * @param deadLetterQueue
      */
     createDeadLetterQueueForLambda(id: string, scope: CommonConstruct, props: LambdaProps, deadLetterQueue: sqs.IQueue): cdk.aws_sqs.Queue;
 }

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

@@ -28,9 +28,6 @@ const cdk = __importStar(require("aws-cdk-lib"));
 const sqs = __importStar(require("aws-cdk-lib/aws-sqs"));
 const utils = __importStar(require("../../../utils"));
 /**
- * @stability stable
- * @category cdk-utils.sqs-manager
- * @subcategory Construct
  * @classdesc Provides operations on AWS Simple Queue 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.
@@ -44,35 +41,27 @@ const utils = __importStar(require("../../../utils"));
  *     this.sqsManager.createQueue('MySqs', this, {...})
  *   }
  * }
- *
  * @see [CDK Simple Queue Service Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs-readme.html}
  */
 class SqsManager {
     /**
      * @summary Method to create a lambda queue service
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {QueueProps} props
-     * @param {sqs.IQueue} deadLetterQueue
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param deadLetterQueue
      */
     createQueue(id, scope, props, deadLetterQueue) {
         if (!props)
             throw `Queue props undefined for ${id}`;
         const queue = new sqs.Queue(scope, id, {
-            queueName: props.queueName,
-            visibilityTimeout: props.visibilityTimeoutInSecs
-                ? cdk.Duration.seconds(props.visibilityTimeoutInSecs)
-                : props.visibilityTimeout,
-            receiveMessageWaitTime: props.receiveMessageWaitTimeInSecs
-                ? cdk.Duration.seconds(props.receiveMessageWaitTimeInSecs)
-                : props.receiveMessageWaitTime,
             contentBasedDeduplication: props.contentBasedDeduplication,
             dataKeyReuse: props.dataKeyReuseInSecs ? cdk.Duration.seconds(props.dataKeyReuseInSecs) : props.dataKeyReuse,
             deadLetterQueue: !deadLetterQueue
                 ? undefined
                 : {
-                    queue: deadLetterQueue,
                     maxReceiveCount: props.maxReceiveCount ?? 5,
+                    queue: deadLetterQueue,
                 },
             deduplicationScope: props.deduplicationScope,
             deliveryDelay: props.deliveryDelayInSecs ? cdk.Duration.seconds(props.deliveryDelayInSecs) : undefined,
@@ -81,8 +70,15 @@ class SqsManager {
             fifo: props.fifo,
             fifoThroughputLimit: props.fifoThroughputLimit,
             maxMessageSizeBytes: props.maxMessageSizeBytes,
+            queueName: props.queueName,
+            receiveMessageWaitTime: props.receiveMessageWaitTimeInSecs
+                ? cdk.Duration.seconds(props.receiveMessageWaitTimeInSecs)
+                : props.receiveMessageWaitTime,
             removalPolicy: props.removalPolicy ?? cdk.RemovalPolicy.DESTROY,
             retentionPeriod: props.retentionInDays ? cdk.Duration.days(props.retentionInDays) : cdk.Duration.days(7),
+            visibilityTimeout: props.visibilityTimeoutInSecs
+                ? cdk.Duration.seconds(props.visibilityTimeoutInSecs)
+                : props.visibilityTimeout,
         });
         if (props.tags && props.tags.length > 0) {
             props.tags.forEach(tag => {
@@ -96,9 +92,9 @@ class SqsManager {
     }
     /**
      * @summary Method to create a redrive queue for a lambda function
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {LambdaProps} props the lambda properties
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props the lambda properties
      */
     createRedriveQueueForLambda(id, scope, props) {
         return this.createQueue(`${id}`, scope, {
@@ -110,10 +106,10 @@ class SqsManager {
     }
     /**
      * @summary Method to create a dead letter queue for a lambda function
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {LambdaProps} props the lambda properties
-     * @param {sqs.IQueue} deadLetterQueue
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props the lambda properties
+     * @param deadLetterQueue
      */
     createDeadLetterQueueForLambda(id, scope, props, deadLetterQueue) {
         let queueProps;

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

@@ -1,17 +1,15 @@
 import * as sqs from 'aws-cdk-lib/aws-sqs';
 import { TagProps } from '../../../types';
 /**
- * @category cdk-utils.sqs-manager
- * @subcategory Properties
  */
 export interface QueueProps extends sqs.QueueProps {
-    maxReceiveCount?: number;
-    visibilityTimeoutInSecs?: number;
-    receiveMessageWaitTimeInSecs?: number;
     dataKeyReuseInSecs?: number;
     deliveryDelayInSecs?: number;
+    maxReceiveCount?: number;
+    receiveMessageWaitTimeInSecs?: number;
     retentionInDays?: number;
-    tags?: TagProps[];
     retriesEnabled?: boolean;
     retryBatchSize?: number;
+    tags?: TagProps[];
+    visibilityTimeoutInSecs?: number;
 }

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

@@ -5,9 +5,6 @@ import * as s3deploy from 'aws-cdk-lib/aws-s3-deployment';
 import { LifecycleRule, S3BucketProps } from './types';
 import { CommonConstruct } from '../../../common';
 /**
- * @stability stable
- * @category cdk-utils.s3-manager
- * @subcategory Construct
  * @classdesc Provides operations on AWS S3.
  * - 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,68 +18,63 @@ import { CommonConstruct } from '../../../common';
  *     this.s3Manager.createS3Bucket('MyBucket', this)
  *   }
  * }
- *
  * @see [CDK S3 Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3-readme.html}
  */
 export declare class S3Manager {
     /**
      * @summary Method to determine S3 Bucket lifecycle properties
-     * @param {S3BucketProps} props bucket properties
-     * @private
+     * @param props bucket properties
      */
     protected determineBucketLifecycleRules(props: S3BucketProps): LifecycleRule[] | undefined;
     /**
      * @summary Method to determine the bucket name using account and region
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {string} bucketName the bucket name
-     * @protected
+     * @param scope scope in which this resource is defined
+     * @param bucketName the bucket name
      */
     protected static determineBucketNameByAccountAndRegion(scope: CommonConstruct, bucketName: string): string;
     /**
      * @summary Method to determine the bucket name using domain name
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {string} bucketName the bucket name
-     * @protected
+     * @param scope scope in which this resource is defined
+     * @param bucketName the bucket name
      */
     protected static determineBucketNameByDomainName(scope: CommonConstruct, bucketName: string): string;
     /**
      * @summary Method to determine the bucket name
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {string} bucketName the bucket name
-     * @private
+     * @param scope scope in which this resource is defined
+     * @param bucketName the bucket name
      */
     static determineBucketName(scope: CommonConstruct, bucketName: string): string;
     /**
      * @summary Method to create a s3 bucket
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {S3BucketProps} props bucket properties
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props bucket properties
      */
     createS3Bucket(id: string, scope: CommonConstruct, props: S3BucketProps): cdk.aws_s3.IBucket;
     /**
      * @summary Method to create an iam bucket policy for cloudtrail
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {s3.IBucket} bucket
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param bucket
      */
     createBucketPolicyForCloudTrail(id: string, scope: CommonConstruct, bucket: s3.IBucket): cdk.aws_s3.CfnBucketPolicy;
     /**
      * @summary Method to create a s3 bucket deployment
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {s3.IBucket} siteBucket
-     * @param {cloudfront.IDistribution} distribution
-     * @param {s3deploy.ISource[]} sources
-     * @param {string} prefix
-     * @param {boolean} prune
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param siteBucket
+     * @param distribution
+     * @param sources
+     * @param prefix
+     * @param prune
      */
     doBucketDeployment(id: string, scope: CommonConstruct, siteBucket: s3.IBucket, distribution: cloudfront.IDistribution, sources: s3deploy.ISource[], prefix: string, prune?: boolean): void;
     /**
      *
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {s3.IBucket} bucket bucket to create the folders in
-     * @param {string[]} folders list of folder names to be created in the 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
+     * @param folders list of folder names to be created in the bucket
      */
     createBucketFolders(id: string, scope: CommonConstruct, bucket: s3.IBucket, folders: string[]): void;
 }