alchemy 2.0.0-beta.cli-platform-split → 2.0.0-beta.pkg-setup-rc

package/lib/AWS/EC2/Instance.d.ts

@@ -0,0 +1,265 @@
+import type { Credentials } from "@distilled.cloud/aws/Credentials";
+import { Region } from "@distilled.cloud/aws/Region";
+import * as FileSystem from "effect/FileSystem";
+import type * as rolldown from "rolldown";
+import type { Input } from "../../Input.ts";
+import { Platform, type Main, type PlatformProps } from "../../Platform.ts";
+import * as Provider from "../../Provider.ts";
+import { Resource } from "../../Resource.ts";
+import type { Providers } from "../Providers.ts";
+import type { ServerHost } from "../../Server/Process.ts";
+import { Stack } from "../../Stack.ts";
+import { Stage } from "../../Stage.ts";
+import type { AccountID } from "../Account.ts";
+import { Account } from "../Account.ts";
+import type { PolicyStatement } from "../IAM/Policy.ts";
+import type { RegionID } from "../Region.ts";
+import { type Ec2HostExecutionContext } from "./hosted.ts";
+import type { SecurityGroupId } from "./SecurityGroup.ts";
+import type { SubnetId } from "./Subnet.ts";
+import type { VpcId } from "./Vpc.ts";
+export type InstanceId<ID extends string = string> = `i-${ID}`;
+export declare const InstanceId: <ID extends string>(id: ID) => ID & InstanceId<ID>;
+export type InstanceArn<ID extends InstanceId = InstanceId> = `arn:aws:ec2:${RegionID}:${AccountID}:instance/${ID}`;
+export declare const isInstance: (value: any) => value is Instance;
+export interface InstanceProps extends PlatformProps {
+    /**
+     * AMI ID to launch.
+     */
+    imageId: string;
+    /**
+     * EC2 instance type, such as `t3.micro`.
+     */
+    instanceType: string;
+    /**
+     * Optional subnet to launch into.
+     */
+    subnetId?: Input<SubnetId>;
+    /**
+     * Security groups to attach to the primary network interface.
+     */
+    securityGroupIds?: Input<SecurityGroupId>[];
+    /**
+     * Optional EC2 key pair name for SSH access.
+     */
+    keyName?: string;
+    /**
+     * Optional IAM instance profile name to attach at launch.
+     */
+    instanceProfileName?: string;
+    /**
+     * User data script to provide at launch time.
+     */
+    userData?: string;
+    /**
+     * Whether to associate a public IPv4 address on launch.
+     */
+    associatePublicIpAddress?: boolean;
+    /**
+     * Optional private IPv4 address for the primary interface.
+     */
+    privateIpAddress?: string;
+    /**
+     * Optional availability zone override.
+     */
+    availabilityZone?: string;
+    /**
+     * Whether source/destination checking is enabled.
+     * @default true
+     */
+    sourceDestCheck?: boolean;
+    /**
+     * User-defined tags to apply to the instance.
+     */
+    tags?: Record<string, string>;
+    /**
+     * Module entrypoint for the bundled instance program.
+     * When omitted, the instance behaves as a low-level EC2 resource.
+     */
+    main?: string;
+    /**
+     * Named export to load from `main`.
+     * @default "default"
+     */
+    handler?: string;
+    /**
+     * Port exposed by the process, if any.
+     * @default 3000
+     */
+    port?: number;
+    /**
+     * Additional environment variables for the hosted process.
+     */
+    env?: Record<string, any>;
+    /**
+     * Bundler configuration for the hosted process entrypoint.
+     */
+    build?: {
+        input?: Partial<rolldown.InputOptions>;
+        output?: Partial<rolldown.OutputOptions>;
+    };
+    /**
+     * Additional managed policy ARNs for the managed instance role.
+     * This can only be used when Alchemy manages the instance profile.
+     */
+    roleManagedPolicyArns?: string[];
+}
+export interface Instance extends Resource<"AWS.EC2.Instance", InstanceProps, {
+    /**
+     * The ID of the instance.
+     */
+    instanceId: InstanceId;
+    /**
+     * The Amazon Resource Name (ARN) of the instance.
+     */
+    instanceArn: InstanceArn;
+    /**
+     * The AMI ID the instance launched from.
+     */
+    imageId: string;
+    /**
+     * The instance type.
+     */
+    instanceType: string;
+    /**
+     * The current instance state.
+     */
+    state: string;
+    /**
+     * The VPC the instance belongs to, if any.
+     */
+    vpcId?: VpcId;
+    /**
+     * The subnet the instance belongs to, if any.
+     */
+    subnetId?: SubnetId;
+    /**
+     * The availability zone of the instance.
+     */
+    availabilityZone?: string;
+    /**
+     * The attached security group IDs.
+     */
+    securityGroupIds: string[];
+    /**
+     * The primary private IPv4 address.
+     */
+    privateIpAddress?: string;
+    /**
+     * The public IPv4 address, if assigned.
+     */
+    publicIpAddress?: string;
+    /**
+     * The private DNS name.
+     */
+    privateDnsName?: string;
+    /**
+     * The public DNS name, if assigned.
+     */
+    publicDnsName?: string;
+    /**
+     * The key pair name used for SSH access.
+     */
+    keyName?: string;
+    /**
+     * The IAM instance profile ARN attached to the instance, if any.
+     */
+    instanceProfileArn?: string;
+    /**
+     * The IAM instance profile ID attached to the instance, if any.
+     */
+    instanceProfileId?: string;
+    /**
+     * The IAM instance profile name attached to the instance, if known.
+     */
+    instanceProfileName?: string;
+    /**
+     * Whether source/destination checking is enabled.
+     */
+    sourceDestCheck?: boolean;
+    /**
+     * When the instance was launched.
+     */
+    launchTime?: string;
+    /**
+     * Current tags on the instance.
+     */
+    tags: Record<string, string>;
+    /**
+     * Role attached by the hosted runtime, if any.
+     */
+    roleArn?: string;
+    /**
+     * Role name attached by the hosted runtime, if any.
+     */
+    roleName?: string;
+    /**
+     * Inline policy name used for bindings/runtime sync, if any.
+     */
+    policyName?: string;
+    /**
+     * Whether the role/profile were created and owned by Alchemy.
+     */
+    managedIam?: boolean;
+    /**
+     * Deterministic runtime unit name for hosted instances.
+     */
+    runtimeUnitName?: string;
+    /**
+     * Asset prefix for hosted bundles and env files.
+     */
+    assetPrefix?: string;
+    /**
+     * Bundle hash for hosted instances.
+     */
+    code?: {
+        hash: string;
+    };
+}, {
+    env?: Record<string, any>;
+    policyStatements?: PolicyStatement[];
+}, Providers> {
+}
+export type InstanceServices = ServerHost | Credentials | Region;
+export type InstanceShape = Main<InstanceServices>;
+export type InstanceExecutionContext = Ec2HostExecutionContext;
+/**
+ * An EC2 instance that can either act as a low-level compute primitive or run
+ * a bundled long-lived Effect program directly on the machine.
+ *
+ * @section Launching Instances
+ * @example Basic Instance
+ * ```typescript
+ * const instance = yield* AWS.EC2.Instance("AppInstance", {
+ *   imageId,
+ *   instanceType: "t3.micro",
+ *   subnetId: subnet.subnetId,
+ * });
+ * ```
+ *
+ * @section Hosting Processes
+ * @example HTTP Server on an Instance
+ * ```typescript
+ * const api = yield* Effect.gen(function* () {
+ *   yield* Http.serve(
+ *     HttpServerResponse.json({ ok: true }),
+ *   );
+ *
+ *   return {
+ *     main: import.meta.filename,
+ *     imageId,
+ *     instanceType: "t3.small",
+ *     subnetId: subnet.subnetId,
+ *     securityGroupIds: [securityGroup.groupId],
+ *     associatePublicIpAddress: true,
+ *     port: 3000,
+ *   };
+ * }).pipe(
+ *   Effect.provide(AWS.EC2.HttpServer),
+ *   AWS.EC2.Instance("ApiInstance"),
+ * );
+ * ```
+ */
+export declare const Instance: Platform<Instance, InstanceServices, InstanceShape, InstanceExecutionContext>;
+export declare const InstanceProvider: () => import("effect/Layer").Layer<Provider.Provider<Instance>, never, FileSystem.FileSystem | import("effect/Path").Path | Stage | Stack | Account | import("../Assets.ts").AssetsRequirements>;
+//# sourceMappingURL=Instance.d.ts.map

package/lib/AWS/EC2/Instance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Instance.d.ts","sourceRoot":"","sources":["../../../src/AWS/EC2/Instance.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAC;AAEpE,OAAO,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAC;AAGrD,OAAO,KAAK,UAAU,MAAM,mBAAmB,CAAC;AAIhD,OAAO,KAAK,KAAK,QAAQ,MAAM,UAAU,CAAC;AAI1C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,KAAK,IAAI,EAAE,KAAK,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAC5E,OAAO,KAAK,QAAQ,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACvC,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAMvC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EAGL,KAAK,uBAAuB,EAC7B,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAEtC,MAAM,MAAM,UAAU,CAAC,EAAE,SAAS,MAAM,GAAG,MAAM,IAAI,KAAK,EAAE,EAAE,CAAC;AAC/D,eAAO,MAAM,UAAU,GAAI,EAAE,SAAS,MAAM,EAAE,IAAI,EAAE,KAAG,EAAE,GAAG,UAAU,CAAC,EAAE,CACvC,CAAC;AAEnC,MAAM,MAAM,WAAW,CAAC,EAAE,SAAS,UAAU,GAAG,UAAU,IACxD,eAAe,QAAQ,IAAI,SAAS,aAAa,EAAE,EAAE,CAAC;AAExD,eAAO,MAAM,UAAU,GAAI,OAAO,GAAG,KAAG,KAAK,IAAI,QAOhD,CAAC;AAEF,MAAM,WAAW,aAAc,SAAQ,aAAa;IAClD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,eAAe,CAAC,EAAE,CAAC;IAC5C;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC9B;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC1B;;OAEG;IACH,KAAK,CAAC,EAAE;QACN,KAAK,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QACvC,MAAM,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;KAC1C,CAAC;IACF;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;CAClC;AAED,MAAM,WAAW,QAAS,SAAQ,QAAQ,CACxC,kBAAkB,EAClB,aAAa,EACb;IACE;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC;IACvB;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC;IACzB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;IACd;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,IAAI,CAAC,EAAE;QACL,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH,EACD;IACE,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC1B,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;CACtC,EACD,SAAS,CACV;CAAG;AAEJ,MAAM,MAAM,gBAAgB,GAAG,UAAU,GAAG,WAAW,GAAG,MAAM,CAAC;AAEjE,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC;AAEnD,MAAM,MAAM,wBAAwB,GAAG,uBAAuB,CAAC;AAE/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,eAAO,MAAM,QAAQ,EAAE,QAAQ,CAC7B,QAAQ,EACR,gBAAgB,EAChB,aAAa,EACb,wBAAwB,CAGxB,CAAC;AAEH,eAAO,MAAM,gBAAgB,kMAwiB1B,CAAC"}