@gradientedge/cdk-utils 9.8.0 → 9.10.0

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

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

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

@@ -1,8 +1,9 @@
 import { GetSecretValueCommand, SecretsManagerClient } from '@aws-sdk/client-secrets-manager'
 import { Fn } from 'aws-cdk-lib'
-import { Secret, SecretProps } from 'aws-cdk-lib/aws-secretsmanager'
+import { Secret } from 'aws-cdk-lib/aws-secretsmanager'
 import { CommonConstruct } from '../../common'
 import { createCfnOutput, determineCredentials } from '../../utils'
+import { SecretBaseProps } from './types'
 
 /**
  * @classdesc Provides operations on AWS Secrets Manager.
@@ -27,10 +28,13 @@ export class SecretsManager {
    * @param scope scope in which this resource is defined
    * @param props the secret properties
    */
-  public createSecret(id: string, scope: CommonConstruct, props: SecretProps) {
+  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: `${props.secretName}-${scope.props.stage}`,
+      secretName: scope.resourceNameFormatter(props.secretName, props.resourceNameOptions),
     })
 
     createCfnOutput(`${id}-secretName`, scope, secret.secretName)

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

@@ -0,0 +1,6 @@
+import { SecretProps } from 'aws-cdk-lib/aws-secretsmanager'
+import { ResourceNameFormatterProps } from '../../common'
+
+export interface SecretBaseProps extends SecretProps {
+  resourceNameOptions?: ResourceNameFormatterProps
+}

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

@@ -37,11 +37,12 @@ export class SnsManager {
     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: `${props.topicName}-${scope.props.stage}`,
-      topicName: `${props.topicName}-${scope.props.stage}`,
+      displayName: scope.resourceNameFormatter(props.topicName, props.resourceNameOptions),
+      topicName: scope.resourceNameFormatter(props.topicName, props.resourceNameOptions),
     })
 
     if (emails && !_.isEmpty(emails)) {
@@ -68,11 +69,12 @@ export class SnsManager {
     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: `${props.topicName}-${scope.props.stage}`,
-      topicName: `${props.topicName}-${scope.props.stage}`,
+      displayName: scope.resourceNameFormatter(props.topicName, props.resourceNameOptions),
+      topicName: scope.resourceNameFormatter(props.topicName, props.resourceNameOptions),
     })
 
     topic.addSubscription(new LambdaSubscription(lambdaFunction))

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

@@ -1,5 +1,8 @@
 import { TopicProps } from 'aws-cdk-lib/aws-sns'
+import { ResourceNameFormatterProps } from '../../common'
 
 /**
  */
-export interface SubscriptionProps extends TopicProps {}
+export interface SubscriptionProps extends TopicProps {
+  resourceNameOptions?: ResourceNameFormatterProps
+}

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

@@ -32,6 +32,10 @@ export class SqsManager {
    */
   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(props.queueName, props.resourceNameOptions)
+    if (props.fifo) queueName += '.fifo'
 
     const queue = new Queue(scope, id, {
       ...props,
@@ -43,6 +47,7 @@ export class SqsManager {
             queue: deadLetterQueue,
           },
       deliveryDelay: props.deliveryDelayInSecs ? Duration.seconds(props.deliveryDelayInSecs) : undefined,
+      queueName,
       receiveMessageWaitTime: props.receiveMessageWaitTimeInSecs
         ? Duration.seconds(props.receiveMessageWaitTimeInSecs)
         : props.receiveMessageWaitTime,
@@ -75,9 +80,7 @@ export class SqsManager {
   public createRedriveQueueForLambda(id: string, scope: CommonConstruct, props: LambdaProps) {
     return this.createQueue(`${id}`, scope, {
       ...props.redriveq,
-      queueName: props.redriveq?.fifo
-        ? `${props.functionName}-redriveq-${scope.props.stage}.fifo`
-        : `${props.functionName}-redriveq-${scope.props.stage}`,
+      queueName: `${props.functionName}-redriveq`,
     })
   }
 
@@ -98,13 +101,11 @@ export class SqsManager {
     if (props.dlq) {
       queueProps = {
         ...props.dlq,
-        queueName: props.dlq.fifo
-          ? `${props.functionName}-dlq-${scope.props.stage}.fifo`
-          : `${props.functionName}-dlq-${scope.props.stage}`,
+        queueName: `${props.functionName}-dlq`,
       }
     } else {
       queueProps = {
-        queueName: `${props.functionName}-dlq-${scope.props.stage}`,
+        queueName: `${props.functionName}-dlq`,
       }
     }
 

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

@@ -1,4 +1,5 @@
 import * as sqs from 'aws-cdk-lib/aws-sqs'
+import { ResourceNameFormatterProps } from '../../common'
 import { TagProps } from '../../types'
 
 /**
@@ -13,4 +14,5 @@ export interface QueueProps extends sqs.QueueProps {
   retryBatchSize?: number
   tags?: TagProps[]
   visibilityTimeoutInSecs?: number
+  resourceNameOptions?: ResourceNameFormatterProps
 }

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

@@ -71,10 +71,14 @@ export class S3Manager {
    * @param scope scope in which this resource is defined
    * @param bucketName the bucket name
    */
-  public static determineBucketName(scope: CommonConstruct, bucketName: string) {
-    return scope.props.excludeDomainNameForBuckets
-      ? S3Manager.determineBucketNameByAccountAndRegion(scope, bucketName)
-      : S3Manager.determineBucketNameByDomainName(scope, bucketName)
+  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(bucketName, props.resourceNameOptions)
   }
 
   /**
@@ -88,15 +92,15 @@ export class S3Manager {
 
     let bucket: IBucket
 
-    const bucketName = S3Manager.determineBucketName(scope, props.bucketName)
+    const bucketName = S3Manager.determineBucketName(scope, props, props.bucketName)
 
     if (props.existingBucket && props.bucketName) {
-      bucket = Bucket.fromBucketName(scope, `${id}`, bucketName)
+      bucket = Bucket.fromBucketName(scope, `${id}`, S3Manager.determineBucketName(scope, props, props.bucketName))
     } else {
       let logBucket
       if (props.logBucketName) {
-        const logBucketName = S3Manager.determineBucketName(scope, props.logBucketName)
-        logBucket = Bucket.fromBucketName(scope, `${id}-logs`, logBucketName)
+        const logBucketName = S3Manager.determineBucketName(scope, props, props.logBucketName)
+        logBucket = Bucket.fromBucketName(scope, `${id}-logs`, props.logBucketName)
       }
 
       bucket = new Bucket(scope, `${id}-bucket`, {

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

@@ -1,6 +1,7 @@
-import { TagProps } from '../../types'
 import * as s3 from 'aws-cdk-lib/aws-s3'
 import * as s3deploy from 'aws-cdk-lib/aws-s3-deployment'
+import { ResourceNameFormatterProps } from '../../common'
+import { TagProps } from '../../types'
 
 /**
  */
@@ -24,5 +25,6 @@ export interface S3BucketProps extends s3.BucketProps {
   existingBucket?: boolean
   lifecycleRules?: LifecycleRule[]
   logBucketName?: string
+  resourceNameOptions?: ResourceNameFormatterProps
   tags?: TagProps[]
 }

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

@@ -474,6 +474,8 @@ export class SfnManager {
     role?: IRole
   ) {
     if (!props) throw `State Machine props undefined for ${id}`
+    if (!props.stateMachineName) throw `State Machine stateMachineName undefined for ${id}`
+
     const stateMachine = new StateMachine(scope, `${id}`, {
       ...props,
       definitionBody: DefinitionBody.fromChainable(definition),
@@ -483,7 +485,7 @@ export class SfnManager {
         level: props.logs?.level ?? LogLevel.ALL,
       },
       role,
-      stateMachineName: `${props.stateMachineName}-${scope.props.stage}`,
+      stateMachineName: scope.resourceNameFormatter(props.stateMachineName, props.resourceNameOptions),
     })
 
     createCfnOutput(`${id}-stateMachineName`, scope, stateMachine.stateMachineName)

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

@@ -18,6 +18,7 @@ import {
   SqsSendMessageProps,
   StepFunctionsStartExecutionProps,
 } from 'aws-cdk-lib/aws-stepfunctions-tasks'
+import { ResourceNameFormatterProps } from '../../common'
 
 /**
  */
@@ -107,7 +108,9 @@ export interface SfnCallApiGatewayRestApiEndpointProps extends CallApiGatewayRes
 
 /**
  */
-export interface SfnStateMachineProps extends StateMachineProps {}
+export interface SfnStateMachineProps extends StateMachineProps {
+  resourceNameOptions?: ResourceNameFormatterProps
+}
 
 /**
  */

package/src/lib/aws/services/virtual-private-cloud/main.ts

@@ -35,15 +35,18 @@ export class VpcManager {
    */
   public createVpc(id: string, scope: CommonConstruct, props: VpcProps) {
     if (!props) throw `Vpc props undefined for ${id}`
+    if (!props.vpcName) throw `Vpc vpcName undefined for ${id}`
 
+    const vpcName = scope.resourceNameFormatter(props.vpcName, props.resourceNameOptions)
     let vpc
     if (props.isIPV6) {
       vpc = new Ipv6Vpc(scope, `${id}`, {
         ...props,
         subnetConfiguration: [
-          { name: `${id}-public`, subnetType: SubnetType.PUBLIC },
-          { name: `${id}-private`, subnetType: SubnetType.PRIVATE_WITH_EGRESS },
+          { name: `${vpcName}-public`, subnetType: SubnetType.PUBLIC },
+          { name: `${vpcName}-private`, subnetType: SubnetType.PRIVATE_WITH_EGRESS },
         ],
+        vpcName,
       })
     } else {
       vpc = new Vpc(scope, `${id}`, props)
@@ -88,6 +91,9 @@ export class VpcManager {
    * @param vpcIdentifier optional identifier for VPC
    */
   public retrieveCommonVpc(id: string, scope: CommonConstruct, vpcIdentifier?: string) {
-    return Vpc.fromLookup(scope, `${id}`, { vpcName: vpcIdentifier ?? CommonVpcIdentifier })
+    const vpcName = scope.resourceNameFormatter(vpcIdentifier ?? CommonVpcIdentifier)
+    return Vpc.fromLookup(scope, `${id}`, {
+      vpcName: scope.resourceNameFormatter(vpcIdentifier ?? CommonVpcIdentifier),
+    })
   }
 }

package/src/lib/aws/services/virtual-private-cloud/types.ts

@@ -1,5 +1,7 @@
 import * as ec2 from 'aws-cdk-lib/aws-ec2'
+import { ResourceNameFormatterProps } from '../../common'
 
 export interface VpcProps extends ec2.VpcProps {
   isIPV6?: boolean
+  resourceNameOptions?: ResourceNameFormatterProps
 }

package/src/lib/aws/services/web-application-firewall/main.ts

@@ -28,11 +28,12 @@ export class WafManager {
    */
   public createIpSet(id: string, scope: CommonConstruct, props: WafIPSetProps) {
     if (!props) throw `WAF Ip Set props undefined for ${id}`
+    if (!props.name) throw `WAF Ip Set name undefined for ${id}`
 
     const ipSet = new CfnIPSet(scope, `${id}`, {
       ...props,
       description: `IP Set for ${id} - ${scope.props.stage} stage`,
-      name: scope.isProductionStage() ? props.name : `${props.name}-${scope.props.stage}`,
+      name: scope.resourceNameFormatter(props.name, props.resourceNameOptions),
     })
 
     createCfnOutput(`${id}-ipSetId`, scope, ipSet.attrId)
@@ -49,11 +50,12 @@ export class WafManager {
    */
   public createWebAcl(id: string, scope: CommonConstruct, props: WafWebACLProps) {
     if (!props) throw `WAF WebACL props undefined for ${id}`
+    if (!props.name) throw `WAF WebACL name undefined for ${id}`
 
     const webAcl = new CfnWebACL(scope, `${id}`, {
       ...props,
       description: `Web Acl for ${id} - ${scope.props.stage} stage`,
-      name: scope.isProductionStage() ? props.name : `${props.name}-${scope.props.stage}`,
+      name: scope.resourceNameFormatter(props.name, props.resourceNameOptions),
       tags: [{ key: 'service', value: scope.props.name }],
     })
 

package/src/lib/aws/services/web-application-firewall/types.ts

@@ -1,9 +1,14 @@
 import { CfnIPSetProps, CfnWebACLProps } from 'aws-cdk-lib/aws-wafv2'
+import { ResourceNameFormatterProps } from '../../common'
 
 /**
  */
-export interface WafIPSetProps extends CfnIPSetProps {}
+export interface WafIPSetProps extends CfnIPSetProps {
+  resourceNameOptions?: ResourceNameFormatterProps
+}
 
 /**
  */
-export interface WafWebACLProps extends CfnWebACLProps {}
+export interface WafWebACLProps extends CfnWebACLProps {
+  resourceNameOptions?: ResourceNameFormatterProps
+}