@infoxchange/make-it-so 1.0.1 → 1.1.0

package/README.md

@@ -44,14 +44,14 @@ if (deployConfig.isIxDeploy) {
 
 Deploys a serverless instance of a Next.js. IxNextjsSite extends [SST's NextjsSite](https://docs.sst.dev/constructs/NextjsSite) and takes the exact same props.
 
-It will automatically create certificates and DNS records for any custom domains given (including alternative domain names which SST doesn't currently do). If the props `customDomain` is not set the first site domain provided by the IX deployment pipeline will be used as the primary custom domain and if there is more than one domain the rest will be used as alternative domain names. Explicitly setting `customDomain` to `undefined` will
+It will automatically create certificates and DNS records for any custom domains given (including alternative domain names which SST doesn't currently do). If the props `customDomain` is not set the first site domain provided by the IX deployment pipeline will be used as the primary custom domain and if there is more than one domain the rest will be used as alternative domain names. Explicitly setting `customDomain` to `undefined` will ensure no customDomain is used.
 
 It will also automatically attach the site to the standard IX VPC created in each workload account (unless you explicitly pass other VPC details or set the VPC-related props (see the SST doco) to `undefined`).
 
 ```typescript
 import { IxNextjsSite } from "@infoxchange/make-it-so/cdk-constructs";
 
-const site = new IxNextjsSite(stack, "site", {
+const site = new IxNextjsSite(stack, "Site", {
   environment: {
     DATABASE_URL: process.env.DATABASE_URL || "",
     SESSION_SECRET: process.env.SESSION_SECRET || "",
@@ -64,6 +64,38 @@ const site = new IxNextjsSite(stack, "site", {
 });
 ```
 
+### CDK Construct - IxElasticache
+
+Deploys an AWS Elasticache cluster, either the redis or the memcached flavour.
+
+It will also automatically attach the cluster to the standard IX VPC created in each workload account (unless you explicitly pass a different VPC to be attached with the vpc prop or set the vpc prop to `undefined` which will stop any VPC being attached).
+
+```typescript
+import { IxElasticache } from "@infoxchange/make-it-so/cdk-constructs";
+
+const redisCluster = new IxElasticache(stack, "elasticache", {
+  autoMinorVersionUpgrade: true,
+  cacheNodeType: "cache.t2.small",
+  engine: "redis",
+  numCacheNodes: 1,
+});
+```
+
+#### Options:
+
+| Prop                      | Type     | Description                                                                                                                                           |
+| ------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
+| vpc                       | IVpc     | (optional) A VPC to attach if not using default IX VPC                                                                                                |
+| vpcSubnetIds              | string[] | (optional) List of IDs of subnets to be used if not using default IX VPC subnets                                                                      |
+| [...CfnCacheClusterProps] |          | Any props accepted by [CfnCacheCluster](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_elasticache.CfnCacheCluster.html#construct-props) |
+
+#### Properties:
+
+| Properties       | Type            | Description                                                      |
+| ---------------- | --------------- | ---------------------------------------------------------------- |
+| connectionString | string          | A string with all the details required to connect to the cluster |
+| cluster          | CfnCacheCluster | An AWS CDK CfnCacheCluster instance                              |
+
 ### CDK Construct - IxCertificate
 
 Creates a new DNS validated ACM certificate for a domain managed by IX.
@@ -71,13 +103,15 @@ Creates a new DNS validated ACM certificate for a domain managed by IX.
 ```typescript
 import { IxCertificate } from "@infoxchange/make-it-so/cdk-constructs";
 
-const domainCert = new IxCertificate(scope, "IxCertificate", {
+const domainCert = new IxCertificate(scope, "ExampleDotComCertificate", {
   domainName: "example.com",
   subjectAlternativeNames: ["other-domain.com"],
   region: "us-east-1",
 });
 ```
 
+#### Options:
+
 | Prop                    | Type     | Description                                                     |
 | ----------------------- | -------- | --------------------------------------------------------------- |
 | domainName              | string   | Domain name for cert                                            |
@@ -91,7 +125,7 @@ Creates a DNS record for a domain managed by IX. Route53 HostedZones for IX mana
 ```typescript
 import { IxDnsRecord } from "@infoxchange/make-it-so/cdk-constructs";
 
-new IxDnsRecord(scope, `DnsRecord-${domainNameLogicalId}`, {
+new IxDnsRecord(scope, "IxDnsRecord", {
   type: "A",
   name: "example.com",
   value: "1.1.1.1",
@@ -99,6 +133,8 @@ new IxDnsRecord(scope, `DnsRecord-${domainNameLogicalId}`, {
 });
 ```
 
+#### Options:
+
 | Prop         | Type                                       | Description                                                                                                                                                                                                                     |
 | ------------ | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | type         | "A" \| "CNAME" \| "NS" \| "SOA" \| "ALIAS" | DNS record type                                                                                                                                                                                                                 |
@@ -115,9 +151,11 @@ Fetches the standard VPC and subnets that exist in all IX workload aws accounts.
 ```typescript
 import { IxVpcDetails } from "@infoxchange/make-it-so/cdk-constructs";
 
-const vpcDetails = new IxVpcDetails(scope, id + "-IxVpcDetails");
+const vpcDetails = new IxVpcDetails(scope, "VpcDetails");
 ```
 
+#### Options:
+
 | Prop                    | Type     | Description                                                     |
 | ----------------------- | -------- | --------------------------------------------------------------- |
 | domainName              | string   | Domain name for cert                                            |

package/dist/cdk-constructs/IxElasticache.d.ts

@@ -0,0 +1,17 @@
+import { Construct } from "constructs";
+import { CfnCacheCluster } from "aws-cdk-lib/aws-elasticache";
+import { IVpc } from "aws-cdk-lib/aws-ec2";
+type ConstructScope = ConstructorParameters<typeof Construct>[0];
+type ConstructId = ConstructorParameters<typeof Construct>[1];
+type CacheClusterProps = ConstructorParameters<typeof CfnCacheCluster>[2];
+type Props = CacheClusterProps & {
+    vpc?: IVpc;
+    vpcSubnetIds?: string[];
+};
+export declare class IxElasticache extends Construct {
+    cluster: CfnCacheCluster;
+    connectionString: string;
+    constructor(scope: ConstructScope, id: ConstructId, { vpc, vpcSubnetIds, ...elasticacheProps }: Props);
+}
+export {};
+//# sourceMappingURL=IxElasticache.d.ts.map

package/dist/cdk-constructs/IxElasticache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IxElasticache.d.ts","sourceRoot":"","sources":["../../src/cdk-constructs/IxElasticache.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,eAAe,EAAkB,MAAM,6BAA6B,CAAC;AAC9E,OAAO,EAAE,IAAI,EAA6B,MAAM,qBAAqB,CAAC;AAMtE,KAAK,cAAc,GAAG,qBAAqB,CAAC,OAAO,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AACjE,KAAK,WAAW,GAAG,qBAAqB,CAAC,OAAO,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AAC9D,KAAK,iBAAiB,GAAG,qBAAqB,CAAC,OAAO,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;AAE1E,KAAK,KAAK,GAAG,iBAAiB,GAAG;IAC/B,GAAG,CAAC,EAAE,IAAI,CAAC;IACX,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB,CAAC;AAEF,qBAAa,aAAc,SAAQ,SAAS;IAC1C,OAAO,EAAE,eAAe,CAAC;IAEzB,gBAAgB,EAAE,MAAM,CAAC;gBAGvB,KAAK,EAAE,cAAc,EACrB,EAAE,EAAE,WAAW,EACf,EAAE,GAAG,EAAE,YAAY,EAAE,GAAG,gBAAgB,EAAE,EAAE,KAAK;CAqFpD"}

package/dist/cdk-constructs/IxElasticache.js

@@ -0,0 +1,70 @@
+import { Construct } from "constructs";
+import { CfnCacheCluster, CfnSubnetGroup } from "aws-cdk-lib/aws-elasticache";
+import { SecurityGroup, Peer, Port } from "aws-cdk-lib/aws-ec2";
+import { StringParameter } from "aws-cdk-lib/aws-ssm";
+import { Stack } from "aws-cdk-lib";
+import { IxVpcDetails } from "./IxVpcDetails.js";
+import deployConfig from "../deployConfig.js";
+export class IxElasticache extends Construct {
+    cluster;
+    connectionString;
+    constructor(scope, id, { vpc, vpcSubnetIds, ...elasticacheProps }) {
+        super(scope, id);
+        // Setup cluster name
+        if (!elasticacheProps.clusterName && deployConfig.isIxDeploy) {
+            elasticacheProps.clusterName = `${Stack.of(this).stackName}`;
+        }
+        if (!elasticacheProps.cacheSubnetGroupName) {
+            // Setup VPC
+            if (!vpc && deployConfig.isIxDeploy) {
+                const vpcDetails = new IxVpcDetails(scope, id + "-IxVpcDetails");
+                vpc = vpcDetails.vpc;
+            }
+            // Setup VPC subnets
+            if (vpc && !vpcSubnetIds) {
+                if (deployConfig.isIxDeploy) {
+                    vpcSubnetIds = [1, 2, 3].map((subnetNum) => StringParameter.valueForStringParameter(scope, `/vpc/subnet/private-${deployConfig.workloadGroup}/${subnetNum}/id`));
+                }
+                else {
+                    vpcSubnetIds = vpc.privateSubnets.map((subnet) => subnet.subnetId);
+                    if (!vpcSubnetIds.length) {
+                        throw Error(`The vpc ${vpc.vpcId} has no private subnets.`);
+                    }
+                }
+            }
+        }
+        // Setup cluster security group
+        if (vpc && vpcSubnetIds) {
+            const subnetGroup = new CfnSubnetGroup(scope, "ElasticacheSubnetGroup", {
+                subnetIds: vpcSubnetIds,
+                description: "Subnet group for redis",
+            });
+            elasticacheProps.cacheSubnetGroupName = subnetGroup.ref;
+            const namePrefix = elasticacheProps.clusterName
+                ? elasticacheProps.clusterName
+                : `${Stack.of(this).stackName}`;
+            const securityGroup = new SecurityGroup(scope, "ElasticacheSecurityGroup", {
+                vpc,
+                allowAllOutbound: true,
+                description: "Security group for Elasticache Cluster",
+                securityGroupName: `${namePrefix}-elasticache`,
+            });
+            for (const subnetIndex of [1, 2, 3]) {
+                const cidr = StringParameter.valueForStringParameter(scope, `/vpc/subnet/private-${deployConfig.workloadGroup}/${subnetIndex}/cidr`);
+                securityGroup.addIngressRule(Peer.ipv4(cidr), Port.tcp(6379), `Allow access to Elasticache cluster from private ${deployConfig.workloadGroup} subnet`);
+            }
+            elasticacheProps.vpcSecurityGroupIds = [securityGroup.securityGroupId];
+        }
+        // Create Redis Cluster
+        this.cluster = new CfnCacheCluster(scope, "RedisCluster", elasticacheProps);
+        if (elasticacheProps.engine === "redis") {
+            this.connectionString = `redis://${this.cluster.attrRedisEndpointAddress}:${this.cluster.attrRedisEndpointPort}`;
+        }
+        else if (elasticacheProps.engine === "memcached") {
+            this.connectionString = `${this.cluster.attrConfigurationEndpointAddress}:${this.cluster.attrConfigurationEndpointPort}`;
+        }
+        else {
+            throw Error(`Unsupported engine: ${elasticacheProps.engine}`);
+        }
+    }
+}

package/dist/cdk-constructs/IxVpcDetails.js

@@ -15,7 +15,7 @@ export class IxVpcDetails extends Construct {
         return Vpc.fromLookup(scope, id + "-Vpc", { vpcId });
     }
     getVpcSubnet(scope) {
-        const vpcSubnetIds = [1, 2, 3].map((subnetNum) => StringParameter.valueFromLookup(scope, `/vpc/subnet/private-${ixDeployConfig.workloadGroup}/${subnetNum}/id`));
+        const vpcSubnetIds = [1, 2, 3].map((subnetNum) => StringParameter.valueForStringParameter(scope, `/vpc/subnet/private-${ixDeployConfig.workloadGroup}/${subnetNum}/id`));
         return {
             subnetFilters: [SubnetFilter.byIds(vpcSubnetIds)],
         };

package/dist/cdk-constructs/index.d.ts

@@ -2,4 +2,5 @@ export * from "./IxVpcDetails.js";
 export * from "./IxCertificate.js";
 export * from "./IxDnsRecord.js";
 export * from "./IxNextjsSite.js";
+export * from "./IxElasticache.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/cdk-constructs/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cdk-constructs/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cdk-constructs/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC"}

package/dist/cdk-constructs/index.js

@@ -2,3 +2,4 @@ export * from "./IxVpcDetails.js";
 export * from "./IxCertificate.js";
 export * from "./IxDnsRecord.js";
 export * from "./IxNextjsSite.js";
+export * from "./IxElasticache.js";

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@infoxchange/make-it-so",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "Makes deploying services to IX infra easy",
+  "repository": "github:infoxchange/make-it-so",
   "type": "module",
   "scripts": {
     "build": "tsc",

package/src/cdk-constructs/IxElasticache.ts

@@ -0,0 +1,111 @@
+import { Construct } from "constructs";
+import { CfnCacheCluster, CfnSubnetGroup } from "aws-cdk-lib/aws-elasticache";
+import { IVpc, SecurityGroup, Peer, Port } from "aws-cdk-lib/aws-ec2";
+import { StringParameter } from "aws-cdk-lib/aws-ssm";
+import { Stack } from "aws-cdk-lib";
+import { IxVpcDetails } from "./IxVpcDetails.js";
+import deployConfig from "../deployConfig.js";
+
+type ConstructScope = ConstructorParameters<typeof Construct>[0];
+type ConstructId = ConstructorParameters<typeof Construct>[1];
+type CacheClusterProps = ConstructorParameters<typeof CfnCacheCluster>[2];
+
+type Props = CacheClusterProps & {
+  vpc?: IVpc;
+  vpcSubnetIds?: string[];
+};
+
+export class IxElasticache extends Construct {
+  cluster: CfnCacheCluster;
+
+  connectionString: string;
+
+  constructor(
+    scope: ConstructScope,
+    id: ConstructId,
+    { vpc, vpcSubnetIds, ...elasticacheProps }: Props,
+  ) {
+    super(scope, id);
+
+    // Setup cluster name
+    if (!elasticacheProps.clusterName && deployConfig.isIxDeploy) {
+      elasticacheProps.clusterName = `${Stack.of(this).stackName}`;
+    }
+
+    if (!elasticacheProps.cacheSubnetGroupName) {
+      // Setup VPC
+      if (!vpc && deployConfig.isIxDeploy) {
+        const vpcDetails = new IxVpcDetails(scope, id + "-IxVpcDetails");
+        vpc = vpcDetails.vpc;
+      }
+
+      // Setup VPC subnets
+      if (vpc && !vpcSubnetIds) {
+        if (deployConfig.isIxDeploy) {
+          vpcSubnetIds = [1, 2, 3].map((subnetNum) =>
+            StringParameter.valueForStringParameter(
+              scope,
+              `/vpc/subnet/private-${deployConfig.workloadGroup}/${subnetNum}/id`,
+            ),
+          );
+        } else {
+          vpcSubnetIds = vpc.privateSubnets.map((subnet) => subnet.subnetId);
+
+          if (!vpcSubnetIds.length) {
+            throw Error(`The vpc ${vpc.vpcId} has no private subnets.`);
+          }
+        }
+      }
+    }
+
+    // Setup cluster security group
+    if (vpc && vpcSubnetIds) {
+      const subnetGroup = new CfnSubnetGroup(scope, "ElasticacheSubnetGroup", {
+        subnetIds: vpcSubnetIds,
+        description: "Subnet group for redis",
+      });
+
+      elasticacheProps.cacheSubnetGroupName = subnetGroup.ref;
+
+      const namePrefix = elasticacheProps.clusterName
+        ? elasticacheProps.clusterName
+        : `${Stack.of(this).stackName}`;
+
+      const securityGroup = new SecurityGroup(
+        scope,
+        "ElasticacheSecurityGroup",
+        {
+          vpc,
+          allowAllOutbound: true,
+          description: "Security group for Elasticache Cluster",
+          securityGroupName: `${namePrefix}-elasticache`,
+        },
+      );
+
+      for (const subnetIndex of [1, 2, 3]) {
+        const cidr = StringParameter.valueForStringParameter(
+          scope,
+          `/vpc/subnet/private-${deployConfig.workloadGroup}/${subnetIndex}/cidr`,
+        );
+        securityGroup.addIngressRule(
+          Peer.ipv4(cidr),
+          Port.tcp(6379),
+          `Allow access to Elasticache cluster from private ${deployConfig.workloadGroup} subnet`,
+        );
+      }
+
+      elasticacheProps.vpcSecurityGroupIds = [securityGroup.securityGroupId];
+    }
+
+    // Create Redis Cluster
+    this.cluster = new CfnCacheCluster(scope, "RedisCluster", elasticacheProps);
+
+    if (elasticacheProps.engine === "redis") {
+      this.connectionString = `redis://${this.cluster.attrRedisEndpointAddress}:${this.cluster.attrRedisEndpointPort}`;
+    } else if (elasticacheProps.engine === "memcached") {
+      this.connectionString = `${this.cluster.attrConfigurationEndpointAddress}:${this.cluster.attrConfigurationEndpointPort}`;
+    } else {
+      throw Error(`Unsupported engine: ${elasticacheProps.engine}`);
+    }
+  }
+}

package/src/cdk-constructs/IxVpcDetails.ts

@@ -23,7 +23,7 @@ export class IxVpcDetails extends Construct {
 
   private getVpcSubnet(scope: ConstructScope): SubnetSelection {
     const vpcSubnetIds = [1, 2, 3].map((subnetNum) =>
-      StringParameter.valueFromLookup(
+      StringParameter.valueForStringParameter(
         scope,
         `/vpc/subnet/private-${ixDeployConfig.workloadGroup}/${subnetNum}/id`,
       ),

package/src/cdk-constructs/index.ts

@@ -2,3 +2,4 @@ export * from "./IxVpcDetails.js";
 export * from "./IxCertificate.js";
 export * from "./IxDnsRecord.js";
 export * from "./IxNextjsSite.js";
+export * from "./IxElasticache.js";