@gradientedge/cdk-utils 10.7.0 → 11.0.0

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

@@ -1,77 +0,0 @@
-import { GetSecretValueCommand, SecretsManagerClient } from '@aws-sdk/client-secrets-manager'
-import { Fn } from 'aws-cdk-lib'
-import { Secret } from 'aws-cdk-lib/aws-secretsmanager'
-import { CommonConstruct } from '../../common/index.js'
-import { createCfnOutput, determineCredentials } from '../../utils/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 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
-   */
-  public createSecret(id: string, scope: CommonConstruct, props: SecretBaseProps) {
-    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
-   */
-  public retrieveSecretFromSecretsManager(id: string, scope: CommonConstruct, stackName: string, exportName: string) {
-    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
-   */
-  public async resolveSecretValue(region: string, secretId: string, secretKey: string) {
-    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/src/lib/aws/services/secrets-manager/types.ts

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

package/src/lib/aws/services/simple-notification-service/index.ts

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

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

@@ -1,87 +0,0 @@
-import { IFunction } from 'aws-cdk-lib/aws-lambda'
-import { Topic } from 'aws-cdk-lib/aws-sns'
-import { EmailSubscription, LambdaSubscription } from 'aws-cdk-lib/aws-sns-subscriptions'
-import _ from 'lodash'
-import { CommonConstruct } from '../../common/index.js'
-import { createCfnOutput } from '../../utils/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 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
-   */
-  public createEmailNotificationService(
-    id: string,
-    scope: CommonConstruct,
-    props: SubscriptionProps,
-    emails: string[]
-  ) {
-    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: string) => 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
-   */
-  public createLambdaNotificationService(
-    id: string,
-    scope: CommonConstruct,
-    props: SubscriptionProps,
-    lambdaFunction: IFunction
-  ) {
-    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/src/lib/aws/services/simple-notification-service/types.ts

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

package/src/lib/aws/services/simple-queue-service/index.ts

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

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

@@ -1,114 +0,0 @@
-import { Duration, RemovalPolicy, Tags } from 'aws-cdk-lib'
-import { IQueue, Queue } from 'aws-cdk-lib/aws-sqs'
-import _ from 'lodash'
-import { CommonConstruct } from '../../common/index.js'
-import { createCfnOutput } from '../../utils/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 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
-   */
-  public createQueue(id: string, scope: CommonConstruct, props: QueueProps, deadLetterQueue?: IQueue) {
-    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
-   */
-  public createRedriveQueueForLambda(id: string, scope: CommonConstruct, props: LambdaProps) {
-    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
-   */
-  public createDeadLetterQueueForLambda(
-    id: string,
-    scope: CommonConstruct,
-    props: LambdaProps,
-    deadLetterQueue: IQueue
-  ) {
-    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/src/lib/aws/services/simple-queue-service/types.ts

@@ -1,16 +0,0 @@
-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/src/lib/aws/services/simple-storage-service/index.ts

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

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

@@ -1,223 +0,0 @@
-import { Duration, RemovalPolicy, Stack, Tags } from 'aws-cdk-lib'
-import { IDistribution } from 'aws-cdk-lib/aws-cloudfront'
-import { Effect, PolicyDocument, PolicyStatement, ServicePrincipal } from 'aws-cdk-lib/aws-iam'
-import { BlockPublicAccess, Bucket, BucketEncryption, CfnBucket, CfnBucketPolicy, IBucket } from 'aws-cdk-lib/aws-s3'
-import { BucketDeployment, ISource, ServerSideEncryption, Source } from 'aws-cdk-lib/aws-s3-deployment'
-import _ from 'lodash'
-import { CommonConstruct } from '../../common/index.js'
-import { createCfnOutput } from '../../utils/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 class S3Manager {
-  /**
-   * @summary Method to determine S3 Bucket lifecycle properties
-   * @param props bucket properties
-   */
-  protected determineBucketLifecycleRules(props: S3BucketProps) {
-    if (!props.lifecycleRules) return undefined
-
-    const bucketLifecycleRules: LifecycleRule[] = []
-    _.forEach(props.lifecycleRules, lifecycleRule => {
-      bucketLifecycleRules.push({
-        ...lifecycleRule,
-        expiration: lifecycleRule.expirationInDays ? Duration.days(lifecycleRule.expirationInDays) : undefined,
-        noncurrentVersionExpiration: lifecycleRule.noncurrentVersionExpirationInDays
-          ? Duration.days(lifecycleRule.noncurrentVersionExpirationInDays)
-          : undefined,
-      })
-    })
-
-    return bucketLifecycleRules
-  }
-
-  /**
-   * @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) {
-    return `${bucketName}-${Stack.of(scope).account}-${scope.props.region}-${scope.props.stage}`
-  }
-
-  /**
-   * @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) {
-    return scope.isProductionStage()
-      ? `${bucketName}.${scope.fullyQualifiedDomainName}`
-      : `${bucketName}-${scope.props.stage}.${scope.fullyQualifiedDomainName}`
-  }
-
-  /**
-   * @summary Method to determine the bucket name
-   * @param scope scope in which this resource is defined
-   * @param bucketName the bucket name
-   */
-  public static determineBucketName(scope: CommonConstruct, props: S3BucketProps, bucketName: string) {
-    if (!scope.props.excludeDomainNameForBuckets) {
-      return S3Manager.determineBucketNameByDomainName(scope, bucketName)
-    }
-    if (!scope.props.excludeAccountNumberForBuckets) {
-      return S3Manager.determineBucketNameByAccountAndRegion(scope, bucketName)
-    }
-    return scope.resourceNameFormatter.format(bucketName, scope.props.resourceNameOptions?.s3)
-  }
-
-  /**
-   * @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
-   */
-  public createS3Bucket(id: string, scope: CommonConstruct, props: S3BucketProps) {
-    if (!props) throw `S3 props undefined for ${id}`
-
-    let bucket: IBucket
-
-    const bucketName = S3Manager.determineBucketName(scope, props, props.bucketName)
-
-    if (props.existingBucket && props.bucketName) {
-      bucket = Bucket.fromBucketName(scope, `${id}`, S3Manager.determineBucketName(scope, props, props.bucketName))
-    } else {
-      let logBucket
-      if (props.logBucketName) {
-        logBucket = Bucket.fromBucketName(
-          scope,
-          `${id}-logs`,
-          S3Manager.determineBucketName(scope, props, props.logBucketName)
-        )
-      }
-
-      bucket = new Bucket(scope, `${id}-bucket`, {
-        ...props,
-        blockPublicAccess: props.blockPublicAccess || BlockPublicAccess.BLOCK_ALL,
-        bucketName,
-        encryption: props.encryption || BucketEncryption.S3_MANAGED,
-        lifecycleRules: this.determineBucketLifecycleRules(props),
-        removalPolicy: props.removalPolicy || RemovalPolicy.RETAIN,
-        serverAccessLogsBucket: logBucket,
-      })
-
-      const cfnBucket = bucket.node.defaultChild as CfnBucket
-      cfnBucket.notificationConfiguration = {
-        eventBridgeConfiguration: {
-          eventBridgeEnabled: props.enableEventBridge ?? false,
-        },
-      }
-    }
-
-    if (props.tags && !_.isEmpty(props.tags)) {
-      _.forEach(props.tags, tag => {
-        Tags.of(bucket).add(tag.key, tag.value)
-      })
-    }
-
-    createCfnOutput(`${id}-bucketName`, scope, bucket.bucketName)
-    createCfnOutput(`${id}-bucketArn`, scope, bucket.bucketArn)
-
-    return bucket
-  }
-
-  /**
-   * @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
-   */
-  public createBucketPolicyForCloudTrail(id: string, scope: CommonConstruct, bucket: IBucket) {
-    const bucketPolicyDocument = new PolicyDocument({
-      statements: [
-        new PolicyStatement({
-          actions: ['s3:GetBucketAcl'],
-          effect: Effect.ALLOW,
-          principals: [new ServicePrincipal('cloudtrail.amazonaws.com')],
-          resources: [bucket.bucketArn],
-          sid: 'AWSCloudTrailAclCheck20150319',
-        }),
-        new PolicyStatement({
-          actions: ['s3:PutObject'],
-          effect: Effect.ALLOW,
-          principals: [new ServicePrincipal('cloudtrail.amazonaws.com')],
-          resources: [bucket.arnForObjects('*')],
-          sid: 'AWSCloudTrailWrite20150319',
-        }),
-      ],
-    })
-
-    return new CfnBucketPolicy(scope, `${id}`, {
-      bucket: bucket.bucketName,
-      policyDocument: bucketPolicyDocument,
-    })
-  }
-
-  /**
-   * @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
-   */
-  public doBucketDeployment(
-    id: string,
-    scope: CommonConstruct,
-    siteBucket: IBucket,
-    distribution: IDistribution,
-    sources: ISource[],
-    prefix: string,
-    prune?: boolean
-  ) {
-    new BucketDeployment(scope, `${id}`, {
-      destinationBucket: siteBucket,
-      destinationKeyPrefix: prefix,
-      distribution: distribution,
-      distributionPaths: ['/*'],
-      memoryLimit: 1024,
-      prune: !!prune,
-      serverSideEncryption: ServerSideEncryption.AES_256,
-      sources: sources,
-    })
-  }
-
-  /**
-   *
-   * @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
-   */
-  public createBucketFolders(id: string, scope: CommonConstruct, bucket: IBucket, folders: string[]) {
-    if (!folders || folders.length == 0) {
-      throw `Folder unspecified for ${id}`
-    }
-
-    _.forEach(folders, folder => {
-      new BucketDeployment(scope, `${id}-${folder}`, {
-        destinationBucket: bucket,
-        destinationKeyPrefix: folder,
-        prune: false,
-        sources: [Source.data('README.md', `This is the ${folder} folder for ${id}`)],
-      })
-    })
-  }
-}

package/src/lib/aws/services/simple-storage-service/types.ts

@@ -1,28 +0,0 @@
-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'
-
-/**
- */
-export interface LifecycleRule extends s3.LifecycleRule {
-  expirationInDays?: number
-  noncurrentVersionExpirationInDays?: number
-}
-
-/**
- */
-export interface BucketDeploymentProps extends s3deploy.BucketDeploymentProps {
-  expirationInDays?: number
-  noncurrentVersionExpirationInDays?: number
-}
-
-/**
- */
-export interface S3BucketProps extends s3.BucketProps {
-  bucketName: string
-  enableEventBridge?: boolean
-  existingBucket?: boolean
-  lifecycleRules?: LifecycleRule[]
-  logBucketName?: string
-  tags?: TagProps[]
-}

package/src/lib/aws/services/step-function/index.ts

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