import * as memorydb from "@distilled.cloud/aws/memorydb";
import { Unowned } from "alchemy/AdoptPolicy";
import { isResolved } from "alchemy/Diff";
import { createPhysicalName } from "alchemy/PhysicalName";
import * as Provider from "alchemy/Provider";
import { Resource } from "alchemy/Resource";
import { createInternalTags, diffTags, hasAlchemyTags } from "alchemy/Tags";
import * as Data from "effect/Data";
import * as Effect from "effect/Effect";
import * as Schedule from "effect/Schedule";
import * as Stream from "effect/Stream";
import type { Providers } from "../Providers.ts";
import { readMemoryDbTags, sameStringSet } from "./internal.ts";
export class MemoryDBSubnetGroupUnexpectedResponse extends Data.TaggedError(
"MemoryDBSubnetGroupUnexpectedResponse",
)<{
readonly message: string;
readonly cause?: unknown;
}> {}
export interface SubnetGroupProps {
/**
* Name of the subnet group. Must be 1-40 characters. If omitted, a
* deterministic physical name is generated. Changing the name replaces the
* subnet group.
*/
subnetGroupName?: string;
/**
* Human-readable description of the subnet group.
*/
description?: string;
/**
* VPC subnet IDs the subnet group spans. MemoryDB places cluster nodes into
* these subnets, so they should cover at least two Availability Zones for a
* multi-AZ cluster.
*/
subnetIds: string[];
/**
* User-defined tags for the subnet group.
*/
tags?: Record<string, string>;
}
export interface SubnetGroup extends Resource<
"AWS.MemoryDB.SubnetGroup",
SubnetGroupProps,
{
/** Name of the subnet group. */
subnetGroupName: string;
/** ARN of the subnet group. */
subnetGroupArn: string;
/** Description of the subnet group. */
description: string | undefined;
/** ID of the VPC the subnets belong to. */
vpcId: string | undefined;
/** IDs of the subnets in the group. */
subnetIds: string[];
/** Tags on the subnet group (user + internal Alchemy tags). */
tags: Record<string, string>;
},
never,
Providers
> {}
/**
* A MemoryDB subnet group — the set of VPC subnets a MemoryDB cluster's nodes
* are placed into.
*
* Subnet groups are free and provision instantly. A cluster references one by
* name via `subnetGroupName`.
* ### Creating a Subnet Group
* **Example:** Subnet Group Spanning Two Subnets
* ```typescript
* const subnetGroup = yield* SubnetGroup("CacheSubnets", {
* description: "MemoryDB cluster subnets",
* subnetIds: [subnetA.subnetId, subnetB.subnetId],
* });
* ```
*
* @resource
*/
export const SubnetGroup = Resource<SubnetGroup>("AWS.MemoryDB.SubnetGroup");
export const SubnetGroupProvider = () =>
Provider.effect(
SubnetGroup,
Effect.gen(function* () {
const toName = (id: string, props: SubnetGroupProps) =>
props.subnetGroupName
? Effect.succeed(props.subnetGroupName)
: createPhysicalName({ id, maxLength: 40, lowercase: true });
const readGroup = Effect.fn(function* (name: string) {
const response = yield* memorydb
.describeSubnetGroups({ SubnetGroupName: name })
.pipe(Effect.catchTag("SubnetGroupNotFoundFault", () => Effect.undefined));
return response?.SubnetGroups?.[0];
});
const toAttrs = Effect.fn(function* (group: memorydb.SubnetGroup) {
if (!group.Name || !group.ARN) {
return yield* new MemoryDBSubnetGroupUnexpectedResponse({
message: `Subnet group '${group.Name}' is missing its ARN`,
});
}
return {
subnetGroupName: group.Name,
subnetGroupArn: group.ARN,
description: group.Description,
vpcId: group.VpcId,
subnetIds: (group.Subnets ?? [])
.map((s) => s.Identifier)
.filter((id): id is string => id !== undefined),
tags: yield* readMemoryDbTags(group.ARN),
};
});
return {
stables: ["subnetGroupName", "subnetGroupArn"],
diff: Effect.fn(function* ({ id, olds, news }) {
if (!isResolved(news)) return undefined;
if (
(yield* toName(id, olds ?? { subnetIds: [] })) !==
(yield* toName(id, news ?? { subnetIds: [] }))
) {
return { action: "replace" } as const;
}
}),
read: Effect.fn(function* ({ id, olds, output }) {
const name = output?.subnetGroupName ?? (yield* toName(id, olds ?? { subnetIds: [] }));
const group = yield* readGroup(name);
if (!group?.ARN) return undefined;
const attrs = yield* toAttrs(group);
return (yield* hasAlchemyTags(id, attrs.tags)) ? attrs : Unowned(attrs);
}),
reconcile: Effect.fn(function* ({ id, news, output, session }) {
const props = news ?? { subnetIds: [] };
const name = output?.subnetGroupName ?? (yield* toName(id, props));
const internalTags = yield* createInternalTags(id);
const desiredTags = { ...internalTags, ...props.tags };
// 1. Observe — cloud state is authoritative.
let observed = yield* readGroup(name);
// 2. Ensure — create if missing; tolerate AlreadyExists as a race.
if (observed === undefined) {
yield* memorydb
.createSubnetGroup({
SubnetGroupName: name,
Description: props.description,
SubnetIds: props.subnetIds,
Tags: Object.entries(desiredTags).map(([Key, Value]) => ({
Key,
Value,
})),
})
.pipe(Effect.catchTag("SubnetGroupAlreadyExistsFault", () => Effect.void));
observed = yield* readGroup(name);
}
if (observed === undefined) {
return yield* new MemoryDBSubnetGroupUnexpectedResponse({
message: `Subnet group '${name}' not found after create`,
});
}
// 3. Sync — apply description / subnet delta from OBSERVED state.
const update: memorydb.UpdateSubnetGroupRequest = {
SubnetGroupName: name,
};
let mutated = false;
if (props.description !== undefined && props.description !== observed.Description) {
update.Description = props.description;
mutated = true;
}
const observedSubnets = (observed.Subnets ?? [])
.map((s) => s.Identifier)
.filter((s): s is string => s !== undefined);
if (!sameStringSet(props.subnetIds, observedSubnets)) {
update.SubnetIds = props.subnetIds;
mutated = true;
}
if (mutated) {
const response = yield* memorydb.updateSubnetGroup(update);
observed = response.SubnetGroup ?? observed;
}
// 3b. Sync tags — diff against OBSERVED cloud tags.
const arn = observed.ARN;
if (arn) {
const observedTags = yield* readMemoryDbTags(arn);
const { removed, upsert } = diffTags(observedTags, desiredTags);
if (upsert.length > 0) {
yield* memorydb.tagResource({ ResourceArn: arn, Tags: upsert });
}
if (removed.length > 0) {
yield* memorydb.untagResource({
ResourceArn: arn,
TagKeys: removed,
});
}
}
yield* session.note(name);
return yield* toAttrs(observed);
}),
delete: Effect.fn(function* ({ output }) {
// A subnet group still attached to a cluster rejects deletion with
// SubnetGroupInUseFault — retry (bounded) while the cluster releases
// it. NotFound is success (idempotent delete).
yield* memorydb.deleteSubnetGroup({ SubnetGroupName: output.subnetGroupName }).pipe(
Effect.catchTag("SubnetGroupNotFoundFault", () => Effect.void),
Effect.retry({
while: (e) => e._tag === "SubnetGroupInUseFault",
schedule: Schedule.max([Schedule.fixed("5 seconds"), Schedule.recurs(12)]),
}),
);
}),
list: () =>
memorydb.describeSubnetGroups.pages({}).pipe(
Stream.runCollect,
Effect.map((chunk) =>
Array.from(chunk).flatMap((page) =>
(page.SubnetGroups ?? []).filter(
(group) => group.Name !== undefined && group.ARN !== undefined,
),
),
),
Effect.flatMap(Effect.forEach((group) => toAttrs(group), { concurrency: 4 })),
),
};
}),
);