@gradientedge/cdk-utils-aws 1.0.0

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

@@ -0,0 +1,6 @@
+import { HostedZoneProps } from 'aws-cdk-lib/aws-route53';
+/**
+ */
+export interface Route53Props extends HostedZoneProps {
+    useExistingHostedZone?: boolean;
+}

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,2 @@
+export * from './main.js';
+export * from './types.js';

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

@@ -0,0 +1,2 @@
+export * from './main.js';
+export * from './types.js';

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

@@ -0,0 +1,43 @@
+import { Secret } from 'aws-cdk-lib/aws-secretsmanager';
+import { CommonConstruct } from '../../common/index.js';
+import { SecretBaseProps } from './types.js';
+/**
+ * @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.
+ * @example
+ * import { CommonConstruct } from '@gradientedge/cdk-utils'
+ *
+ * class CustomConstruct extends CommonConstruct {
+ *   constructor(parent: Construct, id: string, props: common.CommonStackProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     this.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 {
+    /**
+     * @summary Method to create a secret
+     * @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: SecretBaseProps): Secret;
+    /**
+     * @summary Method to retrieve a secret from secrets manager with a cloudformation export
+     * @param id
+     * @param scope
+     * @param stackName
+     * @param exportName
+     */
+    retrieveSecretFromSecretsManager(id: string, scope: CommonConstruct, stackName: string, exportName: string): import("aws-cdk-lib/aws-secretsmanager").ISecret;
+    /**
+     * @summary Method to resolve secret value from a secret using AWS SDK
+     * @param region the region in which the secret is defined
+     * @param secretId the secret name/ARN
+     * @param secretKey the secret key to resolve the value for
+     */
+    resolveSecretValue(region: string, secretId: string, secretKey: string): Promise<any>;
+}

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

@@ -0,0 +1,71 @@
+import { GetSecretValueCommand, SecretsManagerClient } from '@aws-sdk/client-secrets-manager';
+import { Fn } from 'aws-cdk-lib';
+import { Secret } from 'aws-cdk-lib/aws-secretsmanager';
+import { createCfnOutput, determineCredentials } from '../../utils/index.js';
+/**
+ * @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.
+ * @example
+ * import { CommonConstruct } from '@gradientedge/cdk-utils'
+ *
+ * class CustomConstruct extends CommonConstruct {
+ *   constructor(parent: Construct, id: string, props: common.CommonStackProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     this.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 class SecretsManager {
+    /**
+     * @summary Method to create a secret
+     * @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) {
+        if (!props)
+            throw `Secret props undefined for ${id}`;
+        if (!props.secretName)
+            throw `Secret name undefined for ${id}`;
+        const secret = new Secret(scope, `${id}`, {
+            ...props,
+            secretName: scope.resourceNameFormatter.format(props.secretName, scope.props.resourceNameOptions?.secret),
+        });
+        createCfnOutput(`${id}-secretName`, scope, secret.secretName);
+        createCfnOutput(`${id}-secretArn`, scope, secret.secretArn);
+        return secret;
+    }
+    /**
+     * @summary Method to retrieve a secret from secrets manager with a cloudformation export
+     * @param id
+     * @param scope
+     * @param stackName
+     * @param exportName
+     */
+    retrieveSecretFromSecretsManager(id, scope, stackName, exportName) {
+        return Secret.fromSecretNameV2(scope, `${id}`, Fn.importValue(`${stackName}-${scope.props.stage}-${exportName}`));
+    }
+    /**
+     * @summary Method to resolve secret value from a secret using AWS SDK
+     * @param region the region in which the secret is defined
+     * @param secretId the secret name/ARN
+     * @param secretKey the secret key to resolve the value for
+     */
+    async resolveSecretValue(region, secretId, secretKey) {
+        const client = new SecretsManagerClient({
+            credentials: determineCredentials(),
+            region,
+        });
+        const command = new GetSecretValueCommand({
+            SecretId: secretId,
+        });
+        const response = await client.send(command);
+        if (!response.SecretString)
+            throw `Unable to resolve secret for ${secretId}`;
+        const secretString = JSON.parse(response.SecretString);
+        return secretString[secretKey];
+    }
+}

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

@@ -0,0 +1,3 @@
+import { SecretProps } from 'aws-cdk-lib/aws-secretsmanager';
+export interface SecretBaseProps extends SecretProps {
+}

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,2 @@
+export * from './main.js';
+export * from './types.js';

package/dist/src/services/simple-notification-service/index.js

@@ -0,0 +1,2 @@
+export * from './main.js';
+export * from './types.js';

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

@@ -0,0 +1,38 @@
+import { IFunction } from 'aws-cdk-lib/aws-lambda';
+import { Topic } from 'aws-cdk-lib/aws-sns';
+import { CommonConstruct } from '../../common/index.js';
+import { SubscriptionProps } from './types.js';
+/**
+ * @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.
+ * @example
+ * import { CommonConstruct } from '@gradientedge/cdk-utils'
+ *
+ * class CustomConstruct extends CommonConstruct {
+ *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     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 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[]): Topic;
+    /**
+     * @summary Method to create a lambda notification service
+     * @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: IFunction): Topic;
+}

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

@@ -0,0 +1,68 @@
+import { Topic } from 'aws-cdk-lib/aws-sns';
+import { EmailSubscription, LambdaSubscription } from 'aws-cdk-lib/aws-sns-subscriptions';
+import _ from 'lodash';
+import { createCfnOutput } from '../../utils/index.js';
+/**
+ * @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.
+ * @example
+ * import { CommonConstruct } from '@gradientedge/cdk-utils'
+ *
+ * class CustomConstruct extends CommonConstruct {
+ *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     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 class SnsManager {
+    /**
+     * @summary Method to create an email notification service
+     * @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}`;
+        if (!props.topicName)
+            throw `Subscription topicName undefined for ${id}`;
+        const topic = new Topic(scope, id, {
+            ...props,
+            displayName: scope.resourceNameFormatter.format(props.topicName, scope.props.resourceNameOptions?.sns),
+            topicName: scope.resourceNameFormatter.format(props.topicName, scope.props.resourceNameOptions?.sns),
+        });
+        if (emails && !_.isEmpty(emails)) {
+            _.forEach(emails, (email) => topic.addSubscription(new EmailSubscription(email)));
+        }
+        createCfnOutput(`${id}-subscriptionArn`, scope, topic.topicArn);
+        createCfnOutput(`${id}-subscriptionName`, scope, topic.topicName);
+        return topic;
+    }
+    /**
+     * @summary Method to create a lambda notification service
+     * @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}`;
+        if (!props.topicName)
+            throw `Subscription topicName undefined for ${id}`;
+        const topic = new Topic(scope, id, {
+            ...props,
+            displayName: scope.resourceNameFormatter.format(props.topicName, scope.props.resourceNameOptions?.sns),
+            topicName: scope.resourceNameFormatter.format(props.topicName, scope.props.resourceNameOptions?.sns),
+        });
+        topic.addSubscription(new LambdaSubscription(lambdaFunction));
+        createCfnOutput(`${id}-subscriptionArn`, scope, topic.topicArn);
+        createCfnOutput(`${id}-subscriptionName`, scope, topic.topicName);
+        return topic;
+    }
+}

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

@@ -0,0 +1,5 @@
+import { TopicProps } from 'aws-cdk-lib/aws-sns';
+/**
+ */
+export interface SubscriptionProps extends TopicProps {
+}

package/dist/src/services/simple-notification-service/types.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,2 @@
+export * from './main.js';
+export * from './types.js';

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

@@ -0,0 +1,2 @@
+export * from './main.js';
+export * from './types.js';

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

@@ -0,0 +1,45 @@
+import { IQueue, Queue } from 'aws-cdk-lib/aws-sqs';
+import { CommonConstruct } from '../../common/index.js';
+import { LambdaProps } from '../lambda/index.js';
+import { QueueProps } from './types.js';
+/**
+ * @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.
+ * @example
+ * import { CommonConstruct } from '@gradientedge/cdk-utils'
+ *
+ * class CustomConstruct extends CommonConstruct {
+ *   constructor(parent: Construct, id: string, props: common.CommonStackProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     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 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?: IQueue): Queue;
+    /**
+     * @summary Method to create a redrive queue for a lambda function
+     * @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): Queue;
+    /**
+     * @summary Method to create a dead letter queue for a lambda function
+     * @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: IQueue): Queue;
+}

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

@@ -0,0 +1,101 @@
+import { Duration, RemovalPolicy, Tags } from 'aws-cdk-lib';
+import { Queue } from 'aws-cdk-lib/aws-sqs';
+import _ from 'lodash';
+import { createCfnOutput } from '../../utils/index.js';
+/**
+ * @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.
+ * @example
+ * import { CommonConstruct } from '@gradientedge/cdk-utils'
+ *
+ * class CustomConstruct extends CommonConstruct {
+ *   constructor(parent: Construct, id: string, props: common.CommonStackProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     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 class SqsManager {
+    /**
+     * @summary Method to create a lambda queue service
+     * @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}`;
+        if (!props.queueName)
+            throw `Queue queueName undefined for ${id}`;
+        let queueName = scope.resourceNameFormatter.format(props.queueName, scope.props.resourceNameOptions?.sqs);
+        if (props.fifo)
+            queueName += '.fifo';
+        const queue = new Queue(scope, id, {
+            ...props,
+            dataKeyReuse: props.dataKeyReuseInSecs ? Duration.seconds(props.dataKeyReuseInSecs) : props.dataKeyReuse,
+            deadLetterQueue: !deadLetterQueue
+                ? undefined
+                : {
+                    maxReceiveCount: props.maxReceiveCount ?? 5,
+                    queue: deadLetterQueue,
+                },
+            deliveryDelay: props.deliveryDelayInSecs ? Duration.seconds(props.deliveryDelayInSecs) : undefined,
+            queueName,
+            receiveMessageWaitTime: props.receiveMessageWaitTimeInSecs
+                ? Duration.seconds(props.receiveMessageWaitTimeInSecs)
+                : props.receiveMessageWaitTime,
+            removalPolicy: props.removalPolicy ?? RemovalPolicy.DESTROY,
+            retentionPeriod: props.retentionInDays ? Duration.days(props.retentionInDays) : Duration.days(7),
+            visibilityTimeout: props.visibilityTimeoutInSecs
+                ? Duration.seconds(props.visibilityTimeoutInSecs)
+                : props.visibilityTimeout,
+        });
+        if (props.tags && !_.isEmpty(props.tags)) {
+            _.forEach(props.tags, tag => {
+                Tags.of(queue).add(tag.key, tag.value);
+            });
+        }
+        createCfnOutput(`${id}-queueArn`, scope, queue.queueArn);
+        createCfnOutput(`${id}-queueName`, scope, queue.queueName);
+        createCfnOutput(`${id}-queueUrl`, scope, queue.queueUrl);
+        return queue;
+    }
+    /**
+     * @summary Method to create a redrive queue for a lambda function
+     * @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, {
+            ...props.redriveq,
+            queueName: `${props.functionName}-redriveq`,
+        });
+    }
+    /**
+     * @summary Method to create a dead letter queue for a lambda function
+     * @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;
+        if (props.dlq) {
+            queueProps = {
+                ...props.dlq,
+                queueName: `${props.functionName}-dlq`,
+            };
+        }
+        else {
+            queueProps = {
+                queueName: `${props.functionName}-dlq`,
+            };
+        }
+        return this.createQueue(`${id}`, scope, queueProps, deadLetterQueue);
+    }
+}

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

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

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,2 @@
+export * from './main.js';
+export * from './types.js';

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

@@ -0,0 +1,2 @@
+export * from './main.js';
+export * from './types.js';

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

@@ -0,0 +1,79 @@
+import { IDistribution } from 'aws-cdk-lib/aws-cloudfront';
+import { CfnBucketPolicy, IBucket } from 'aws-cdk-lib/aws-s3';
+import { ISource } from 'aws-cdk-lib/aws-s3-deployment';
+import { CommonConstruct } from '../../common/index.js';
+import { LifecycleRule, S3BucketProps } from './types.js';
+/**
+ * @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.
+ * @example
+ * import { CommonConstruct } from '@gradientedge/cdk-utils'
+ *
+ * class CustomConstruct extends CommonConstruct {
+ *   constructor(parent: Construct, id: string, props: common.CommonStackProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     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 props bucket properties
+     */
+    protected determineBucketLifecycleRules(props: S3BucketProps): LifecycleRule[] | undefined;
+    /**
+     * @summary Method to determine the bucket name using account and region
+     * @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 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 scope scope in which this resource is defined
+     * @param bucketName the bucket name
+     */
+    static determineBucketName(scope: CommonConstruct, props: S3BucketProps, bucketName: string): string;
+    /**
+     * @summary Method to create a s3 bucket
+     * @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): IBucket;
+    /**
+     * @summary Method to create an iam bucket policy for cloudtrail
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param bucket
+     */
+    createBucketPolicyForCloudTrail(id: string, scope: CommonConstruct, bucket: IBucket): CfnBucketPolicy;
+    /**
+     * @summary Method to create a s3 bucket deployment
+     * @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: IBucket, distribution: IDistribution, sources: ISource[], prefix: string, prune?: boolean): void;
+    /**
+     *
+     * @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: IBucket, folders: string[]): void;
+}