alchemy 0.62.3 → 0.63.0

package/src/aws/policy.ts

@@ -1,16 +1,6 @@
-import {
-  CreatePolicyCommand,
-  CreatePolicyVersionCommand,
-  DeletePolicyCommand,
-  DeletePolicyVersionCommand,
-  GetPolicyCommand,
-  GetPolicyVersionCommand,
-  IAMClient,
-  ListPolicyVersionsCommand,
-  NoSuchEntityException,
-} from "@aws-sdk/client-iam";
 import type { Context } from "../context.ts";
 import { Resource } from "../resource.ts";
+import { importPeer } from "../util/peer.ts";
 import { retry } from "./retry.ts";
 
 /**
@@ -89,8 +79,10 @@ export interface PolicyDocument {
 export interface PolicyProps {
   /**
    * Name of the policy
+   *
+   * @default ${app}-${stage}-${id}
    */
-  policyName: string;
+  policyName?: string;
 
   /**
    * Policy document defining the permissions
@@ -122,6 +114,11 @@ export interface Policy extends Resource<"iam::Policy">, PolicyProps {
    */
   arn: string;
 
+  /**
+   * Name of the Policy.
+   */
+  policyName: string;
+
   /**
    * ID of the default policy version
    */
@@ -230,11 +227,30 @@ export const Policy = Resource(
   "iam::Policy",
   async function (
     this: Context<Policy>,
-    _id: string,
+    id: string,
     props: PolicyProps,
   ): Promise<Policy> {
+    const {
+      CreatePolicyCommand,
+      CreatePolicyVersionCommand,
+      DeletePolicyCommand,
+      DeletePolicyVersionCommand,
+      GetPolicyCommand,
+      GetPolicyVersionCommand,
+      IAMClient,
+      ListPolicyVersionsCommand,
+      NoSuchEntityException,
+    } = await importPeer(import("@aws-sdk/client-iam"), "iam::Policy");
     const client = new IAMClient({});
-    const policyArn = `arn:aws:iam::${process.env.AWS_ACCOUNT_ID}:policy${props.path || "/"}${props.policyName}`;
+    const policyName =
+      props.policyName ??
+      this.output?.policyName ??
+      this.scope.createPhysicalName(id);
+    const policyArn = `arn:aws:iam::${process.env.AWS_ACCOUNT_ID}:policy${props.path || "/"}${policyName}`;
+
+    if (this.phase === "update" && this.output.policyName !== policyName) {
+      this.replace();
+    }
 
     if (this.phase === "delete") {
       try {
@@ -351,6 +367,7 @@ export const Policy = Resource(
       return this({
         ...props,
         arn: policy.Policy!.Arn!,
+        policyName,
         defaultVersionId: policy.Policy!.DefaultVersionId!,
         attachmentCount: policy.Policy!.AttachmentCount!,
         createDate: policy.Policy!.CreateDate!,
@@ -363,7 +380,7 @@ export const Policy = Resource(
         const newPolicy = await retry(() =>
           client.send(
             new CreatePolicyCommand({
-              PolicyName: props.policyName,
+              PolicyName: policyName,
               PolicyDocument: JSON.stringify(props.document),
               Description: props.description,
               Path: props.path,
@@ -380,6 +397,7 @@ export const Policy = Resource(
         return this({
           ...props,
           arn: newPolicy.Policy!.Arn!,
+          policyName,
           defaultVersionId: newPolicy.Policy!.DefaultVersionId!,
           attachmentCount: newPolicy.Policy!.AttachmentCount!,
           createDate: newPolicy.Policy!.CreateDate!,

package/src/aws/queue.ts

@@ -1,15 +1,7 @@
-import {
-  CreateQueueCommand,
-  DeleteQueueCommand,
-  GetQueueAttributesCommand,
-  GetQueueUrlCommand,
-  QueueDeletedRecently,
-  QueueDoesNotExist,
-  SQSClient,
-} from "@aws-sdk/client-sqs";
 import type { Context } from "../context.ts";
 import { Resource } from "../resource.ts";
 import { logger } from "../util/logger.ts";
+import { importPeer } from "../util/peer.ts";
 import { retry } from "./retry.ts";
 
 /**
@@ -19,8 +11,10 @@ export interface QueueProps {
   /**
    * Name of the queue
    * For FIFO queues, the name must end with the .fifo suffix
+   *
+   * @default ${app}-${stage}-${id}?.fifo
    */
-  queueName: string;
+  queueName?: string;
 
   /**
    * Whether this is a FIFO queue.
@@ -91,6 +85,11 @@ export interface Queue extends Resource<"sqs::Queue">, QueueProps {
    */
   arn: string;
 
+  /**
+   * Name of the Queue
+   */
+  queueName: string;
+
   /**
    * URL of the queue
    */
@@ -140,18 +139,34 @@ export const Queue = Resource(
   "sqs::Queue",
   async function (
     this: Context<Queue>,
-    _id: string,
+    id: string,
     props: QueueProps,
   ): Promise<Queue> {
+    const {
+      CreateQueueCommand,
+      DeleteQueueCommand,
+      GetQueueAttributesCommand,
+      GetQueueUrlCommand,
+      QueueDeletedRecently,
+      QueueDoesNotExist,
+      SQSClient,
+    } = await importPeer(import("@aws-sdk/client-sqs"), "sqs::Queue");
     const client = new SQSClient({});
     // Don't automatically add .fifo suffix - user must include it in queueName
-    const queueName = props.queueName;
+    const queueName =
+      props.queueName ??
+      this.output?.queueName ??
+      `${this.scope.createPhysicalName(id)}${props.fifo ? ".fifo" : ""}`;
 
-    // Validate that FIFO queues have .fifo suffix
     if (props.fifo && !queueName.endsWith(".fifo")) {
+      // Validate that FIFO queues have .fifo suffix
       throw new Error("FIFO queue names must end with .fifo suffix");
     }
 
+    if (this.phase === "update" && this.output.queueName !== queueName) {
+      this.replace();
+    }
+
     if (this.phase === "delete") {
       try {
         // Get queue URL first
@@ -271,6 +286,7 @@ export const Queue = Resource(
       return this({
         ...props,
         arn: attributesResponse.Attributes!.QueueArn!,
+        queueName,
         url: createResponse.QueueUrl!,
       });
     } catch (error: any) {
@@ -311,6 +327,7 @@ export const Queue = Resource(
             return this({
               ...props,
               arn: attributesResponse.Attributes!.QueueArn!,
+              queueName,
               url: createResponse.QueueUrl!,
             });
           } catch (retryError: any) {
@@ -326,21 +343,25 @@ export const Queue = Resource(
       }
       throw error;
     }
-  },
-);
 
-function isQueueDoesNotExist(error: any): error is QueueDoesNotExist {
-  return (
-    error.name === "QueueDoesNotExist" ||
-    error.Code === "AWS.SimpleQueueService.NonExistentQueue" ||
-    error instanceof QueueDoesNotExist
-  );
-}
+    function isQueueDoesNotExist(
+      error: any,
+    ): error is typeof QueueDoesNotExist {
+      return (
+        error.name === "QueueDoesNotExist" ||
+        error.Code === "AWS.SimpleQueueService.NonExistentQueue" ||
+        error instanceof QueueDoesNotExist
+      );
+    }
 
-function isQueueDeletedRecently(error: any): error is QueueDeletedRecently {
-  return (
-    error instanceof QueueDeletedRecently ||
-    error.Code === "AWS.SimpleQueueService.QueueDeletedRecently" ||
-    error.name === "QueueDeletedRecently"
-  );
-}
+    function isQueueDeletedRecently(
+      error: any,
+    ): error is typeof QueueDeletedRecently {
+      return (
+        error instanceof QueueDeletedRecently ||
+        error.Code === "AWS.SimpleQueueService.QueueDeletedRecently" ||
+        error.name === "QueueDeletedRecently"
+      );
+    }
+  },
+);

package/src/aws/role.ts

@@ -1,24 +1,9 @@
-import {
-  AttachRolePolicyCommand,
-  CreateRoleCommand,
-  DeleteRoleCommand,
-  DeleteRolePolicyCommand,
-  DetachRolePolicyCommand,
-  EntityAlreadyExistsException,
-  GetRoleCommand,
-  IAMClient,
-  ListAttachedRolePoliciesCommand,
-  NoSuchEntityException,
-  PutRolePolicyCommand,
-  type Tag,
-  TagRoleCommand,
-  UpdateAssumeRolePolicyCommand,
-  UpdateRoleCommand,
-} from "@aws-sdk/client-iam";
+import type { Tag } from "@aws-sdk/client-iam";
 import type { Context } from "../context.ts";
 import { Resource } from "../resource.ts";
 import { ignore } from "../util/ignore.ts";
 import { logger } from "../util/logger.ts";
+import { importPeer } from "../util/peer.ts";
 import type { PolicyDocument } from "./policy.ts";
 import { retry } from "./retry.ts";
 
@@ -28,8 +13,10 @@ import { retry } from "./retry.ts";
 export interface RoleProps {
   /**
    * Name of the IAM role
+   *
+   * @default ${app}-${stage}-${id}
    */
-  roleName: string;
+  roleName?: string;
 
   /**
    * Policy that defines which entities can assume this role
@@ -86,6 +73,11 @@ export interface Role extends Resource<"iam::Role">, RoleProps {
    */
   arn: string;
 
+  /**
+   * Name of the Role.
+   */
+  roleName: string;
+
   /**
    * Unique identifier for the role
    */
@@ -220,11 +212,36 @@ export const Role = Resource(
   "iam::Role",
   async function (
     this: Context<Role>,
-    _id: string,
+    id: string,
     props: RoleProps,
   ): Promise<Role> {
+    const {
+      AttachRolePolicyCommand,
+      CreateRoleCommand,
+      DeleteRoleCommand,
+      DeleteRolePolicyCommand,
+      DetachRolePolicyCommand,
+      EntityAlreadyExistsException,
+      GetRoleCommand,
+      IAMClient,
+      ListAttachedRolePoliciesCommand,
+      NoSuchEntityException,
+      PutRolePolicyCommand,
+      TagRoleCommand,
+      UpdateAssumeRolePolicyCommand,
+      UpdateRoleCommand,
+    } = await importPeer(import("@aws-sdk/client-iam"), "iam::Role");
     const client = new IAMClient({});
 
+    const roleName =
+      props.roleName ??
+      this.output?.roleName ??
+      this.scope.createPhysicalName(id);
+
+    if (this.phase === "update" && this.output.roleName !== roleName) {
+      this.replace();
+    }
+
     if (this.phase === "delete") {
       try {
         // Delete any inline policies first
@@ -523,7 +540,7 @@ export const Role = Resource(
       arn: role.Role.Arn!,
       uniqueId: role.Role.RoleId!,
       roleId: role.Role.RoleId!,
-      roleName: role.Role.RoleName ?? props.roleName,
+      roleName,
       createDate: role.Role.CreateDate!,
     });
   },

package/src/aws/ses.ts

@@ -1,27 +1,14 @@
-import {
-  CreateConfigurationSetCommand,
-  CreateEmailIdentityCommand,
-  DeleteConfigurationSetCommand,
-  DeleteEmailIdentityCommand,
-  type DeliveryOptions,
-  GetConfigurationSetCommand,
-  GetEmailIdentityCommand,
-  NotFoundException,
-  PutConfigurationSetDeliveryOptionsCommand,
-  PutConfigurationSetReputationOptionsCommand,
-  PutConfigurationSetSendingOptionsCommand,
-  PutConfigurationSetSuppressionOptionsCommand,
-  PutConfigurationSetTrackingOptionsCommand,
-  PutEmailIdentityDkimAttributesCommand,
-  type ReputationOptions,
-  SESv2Client,
-  type SendingOptions,
-  type SuppressionOptions,
-  type TrackingOptions,
+import type {
+  DeliveryOptions,
+  ReputationOptions,
+  SendingOptions,
+  SuppressionOptions,
+  TrackingOptions,
 } from "@aws-sdk/client-sesv2";
 import type { Context } from "../context.ts";
 import { Resource } from "../resource.ts";
 import { ignore } from "../util/ignore.ts";
+import { importPeer } from "../util/peer.ts";
 import { retry } from "./retry.ts";
 
 /**
@@ -165,6 +152,23 @@ export const SES = Resource(
     props: SESProps,
   ): Promise<SES> {
     // Create SES client
+    const {
+      CreateConfigurationSetCommand,
+      CreateEmailIdentityCommand,
+      DeleteConfigurationSetCommand,
+      DeleteEmailIdentityCommand,
+      GetConfigurationSetCommand,
+      GetEmailIdentityCommand,
+      NotFoundException,
+      PutConfigurationSetDeliveryOptionsCommand,
+      PutConfigurationSetReputationOptionsCommand,
+      PutConfigurationSetSendingOptionsCommand,
+      PutConfigurationSetSuppressionOptionsCommand,
+      PutConfigurationSetTrackingOptionsCommand,
+      PutEmailIdentityDkimAttributesCommand,
+      SESv2Client,
+    } = await importPeer(import("@aws-sdk/client-sesv2"), "ses::SES");
+
     const client = new SESv2Client({});
 
     // Resource ID is either based on the configuration set name or email identity

package/src/aws/ssm-parameter.ts

@@ -1,18 +1,10 @@
-import {
-  AddTagsToResourceCommand,
-  DeleteParameterCommand,
-  GetParameterCommand,
-  ParameterAlreadyExists,
-  ParameterNotFound,
-  PutParameterCommand,
-  SSMClient,
-  type Tag,
-} from "@aws-sdk/client-ssm";
+import type { Tag } from "@aws-sdk/client-ssm";
 import type { Context } from "../context.ts";
 import { Resource } from "../resource.ts";
 import { type Secret, isSecret } from "../secret.ts";
 import { ignore } from "../util/ignore.ts";
 import { logger } from "../util/logger.ts";
+import { importPeer } from "../util/peer.ts";
 
 /**
  * Base properties shared by all SSM Parameter types
@@ -20,8 +12,10 @@ import { logger } from "../util/logger.ts";
 interface SSMParameterBaseProps {
   /**
    * Name of the parameter
+   *
+   * @default ${app}-${stage}-${id}
    */
-  name: string;
+  name?: string;
 
   /**
    * Description of the parameter's purpose
@@ -101,6 +95,11 @@ export type SSMParameter = Resource<"ssm::Parameter"> & {
    */
   arn: string;
 
+  /**
+   * Name of the SSM Parameter.
+   */
+  name: string;
+
   /**
    * Version of the parameter
    */
@@ -176,17 +175,33 @@ export const SSMParameter = Resource(
   "ssm::Parameter",
   async function (
     this: Context<SSMParameter>,
-    _id: string,
+    id: string,
     props: SSMParameterProps,
   ): Promise<SSMParameter> {
+    const {
+      AddTagsToResourceCommand,
+      DeleteParameterCommand,
+      GetParameterCommand,
+      ParameterAlreadyExists,
+      ParameterNotFound,
+      PutParameterCommand,
+      SSMClient,
+    } = await importPeer(import("@aws-sdk/client-ssm"), "ssm::Parameter");
     const client = new SSMClient({});
 
+    const parameterName =
+      props.name ?? this.output?.name ?? this.scope.createPhysicalName(id);
+
+    if (this.phase === "update" && this.output.name !== parameterName) {
+      this.replace();
+    }
+
     if (this.phase === "delete") {
       try {
         await ignore(ParameterNotFound.name, () =>
           client.send(
             new DeleteParameterCommand({
-              Name: props.name,
+              Name: parameterName,
             }),
           ),
         );
@@ -217,7 +232,7 @@ export const SSMParameter = Resource(
       try {
         await client.send(
           new PutParameterCommand({
-            Name: props.name,
+            Name: parameterName,
             Value: parameterValue,
             Type: parameterType,
             Description: props.description,
@@ -247,7 +262,7 @@ export const SSMParameter = Resource(
         if (error instanceof ParameterAlreadyExists) {
           await client.send(
             new PutParameterCommand({
-              Name: props.name,
+              Name: parameterName,
               Value: parameterValue,
               Type: parameterType,
               Description: props.description,
@@ -278,7 +293,7 @@ export const SSMParameter = Resource(
           await client.send(
             new AddTagsToResourceCommand({
               ResourceType: "Parameter",
-              ResourceId: props.name,
+              ResourceId: parameterName,
               Tags: tags,
             }),
           );
@@ -290,13 +305,15 @@ export const SSMParameter = Resource(
       // Get the updated parameter
       const parameter = await client.send(
         new GetParameterCommand({
-          Name: props.name,
+          Name: parameterName,
           WithDecryption: true,
         }),
       );
 
       if (!parameter?.Parameter) {
-        throw new Error(`Failed to create or update parameter ${props.name}`);
+        throw new Error(
+          `Failed to create or update parameter ${parameterName}`,
+        );
       }
 
       return this({
@@ -304,12 +321,15 @@ export const SSMParameter = Resource(
         arn: parameter.Parameter.ARN!,
         version: parameter.Parameter.Version!,
         lastModifiedDate: parameter.Parameter.LastModifiedDate!,
-        name: parameter.Parameter.Name ?? props.name,
+        name: parameter.Parameter.Name ?? parameterName,
         value: props.value,
         type: (parameter.Parameter.Type as any) ?? parameterType,
       } as SSMParameter);
     } catch (error: any) {
-      logger.error(`Error creating/updating parameter ${props.name}:`, error);
+      logger.error(
+        `Error creating/updating parameter ${parameterName}:`,
+        error,
+      );
       throw error;
     }
   },

package/src/aws/table.ts

@@ -1,14 +1,8 @@
-import {
-  CreateTableCommand,
-  DeleteTableCommand,
-  DescribeTableCommand,
-  DynamoDBClient,
-  type KeySchemaElement,
-  ResourceNotFoundException,
-} from "@aws-sdk/client-dynamodb";
+import type { KeySchemaElement } from "@aws-sdk/client-dynamodb";
 import type { Context } from "../context.ts";
 import { Resource } from "../resource.ts";
 import { ignore } from "../util/ignore.ts";
+import { importPeer } from "../util/peer.ts";
 import { retry } from "./retry.ts";
 
 /**
@@ -17,8 +11,10 @@ import { retry } from "./retry.ts";
 export interface TableProps {
   /**
    * Name of the DynamoDB table
+   *
+   * @default ${app}-${stage}-${id}
    */
-  tableName: string;
+  tableName?: string;
 
   /**
    * Primary partition key (hash key) configuration
@@ -88,6 +84,11 @@ export interface Table extends Resource<"dynamo::Table">, TableProps {
    */
   arn: string;
 
+  /**
+   * Name of the DynamoDB Table.
+   */
+  tableName: string;
+
   /**
    * ARN of the table's stream if enabled
    * Format: arn:aws:dynamodb:region:account-id:table/table-name/stream/timestamp
@@ -140,17 +141,33 @@ export const Table = Resource(
   "dynamo::Table",
   async function (
     this: Context<Table>,
-    _id: string,
+    id: string,
     props: TableProps,
   ): Promise<Table> {
+    const {
+      CreateTableCommand,
+      DeleteTableCommand,
+      DescribeTableCommand,
+      DynamoDBClient,
+      ResourceNotFoundException,
+    } = await importPeer(import("@aws-sdk/client-dynamodb"), "dynamo::Table");
     const client = new DynamoDBClient({});
 
+    const tableName =
+      props.tableName ??
+      this.output?.tableName ??
+      this.scope.createPhysicalName(id);
+
+    if (this.phase === "update" && this.output?.tableName !== tableName) {
+      this.replace();
+    }
+
     if (this.phase === "delete") {
       await retry(async () => {
         await ignore(ResourceNotFoundException.name, () =>
           client.send(
             new DeleteTableCommand({
-              TableName: props.tableName,
+              TableName: tableName,
             }),
           ),
         );
@@ -165,7 +182,7 @@ export const Table = Resource(
         try {
           await client.send(
             new DescribeTableCommand({
-              TableName: props.tableName,
+              TableName: tableName,
             }),
           );
           // If we get here, table still exists
@@ -184,7 +201,7 @@ export const Table = Resource(
 
       if (!tableDeleted) {
         throw new Error(
-          `Timed out waiting for table ${props.tableName} to be deleted`,
+          `Timed out waiting for table ${tableName} to be deleted`,
         );
       }
 
@@ -222,7 +239,7 @@ export const Table = Resource(
         // First check if table already exists
         const describeResponse = await client.send(
           new DescribeTableCommand({
-            TableName: props.tableName,
+            TableName: tableName,
           }),
         );
 
@@ -240,7 +257,7 @@ export const Table = Resource(
           // Table doesn't exist, try to create it
           await client.send(
             new CreateTableCommand({
-              TableName: props.tableName,
+              TableName: tableName,
               AttributeDefinitions: attributeDefinitions,
               KeySchema: keySchema,
               BillingMode: props.billingMode || "PAY_PER_REQUEST",
@@ -277,7 +294,7 @@ export const Table = Resource(
           async () =>
             await client.send(
               new DescribeTableCommand({
-                TableName: props.tableName,
+                TableName: tableName,
               }),
             ),
         );
@@ -302,13 +319,14 @@ export const Table = Resource(
 
     if (!tableActive) {
       throw new Error(
-        `Timed out waiting for table ${props.tableName} to become active`,
+        `Timed out waiting for table ${tableName} to become active`,
       );
     }
 
     return this({
       ...props,
       arn: tableDescription!.TableArn!,
+      tableName,
       streamArn: tableDescription!.LatestStreamArn,
       tableId: tableDescription!.TableId!,
     });