@sst-community/sst 4.20.0 → 5.0.0-alpha.1

package/platform/types/components/aws/vector.d.ts

@@ -0,0 +1,163 @@
+import { ComponentResourceOptions } from "@pulumi/pulumi";
+import { Component, Transform } from "../component.js";
+import { Postgres, PostgresArgs } from "./postgres-v1.js";
+import { Link } from "../link.js";
+import { Input } from "../input.js";
+export interface VectorArgs {
+    /**
+     * The dimension size of each vector.
+     *
+     * The maximum supported dimension is 2000. To store vectors with greater dimension,
+     * use dimensionality reduction to reduce the dimension to 2000 or less. OpenAI supports
+     * [dimensionality reduction](https://platform.openai.com/docs/api-reference/embeddings/create#embeddings-create-dimensions) automatically when generating embeddings.
+     *
+     * :::caution
+     * Changing the dimension will cause the data to be cleared.
+     * :::
+     *
+     * @example
+     * ```js
+     * {
+     *   dimension: 1536
+     * }
+     * ```
+     */
+    dimension: Input<number>;
+    /**
+     * [Transform](/docs/components#transform) how this component creates its underlying
+     * resources.
+     */
+    transform?: {
+        /**
+         * Transform the Postgres component.
+         */
+        postgres?: Transform<PostgresArgs>;
+    };
+}
+/**
+ * The `Vector` component has been deprecated. It should not be used for new projects.
+ *
+ * :::caution
+ * This component has been deprecated.
+ * :::
+ *
+ * The `Vector` component lets you store and retrieve vector data in your app.
+ *
+ * - It uses a vector database powered by [RDS Postgres Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html).
+ * - Provides a [SDK](/docs/reference/sdk/) to query, put, and remove the vector data.
+ *
+ * @deprecated Use a dedicated vector database provider instead.
+ *
+ * @example
+ *
+ * #### Create the database
+ *
+ * ```ts title="sst.config.ts"
+ * const vector = new sst.aws.Vector("MyVectorDB", {
+ *   dimension: 1536
+ * });
+ * ```
+ *
+ * #### Link to a resource
+ *
+ * You can link it to other resources, like a function or your Next.js app.
+ *
+ * ```ts title="sst.config.ts"
+ * new sst.aws.Nextjs("MyWeb", {
+ *   link: [vector]
+ * });
+ * ```
+ *
+ * Once linked, you can query it in your function code using the [SDK](/docs/reference/sdk/).
+ *
+ * ```ts title="app/page.tsx"
+ * import { VectorClient } from "sst";
+ *
+ * await VectorClient("MyVectorDB").query({
+ *   vector: [32.4, 6.55, 11.2, 10.3, 87.9]
+ * });
+ * ```
+ */
+export declare class Vector extends Component implements Link.Linkable {
+    private postgres;
+    private queryHandler;
+    private putHandler;
+    private removeHandler;
+    constructor(name: string, args: VectorArgs, opts?: ComponentResourceOptions);
+    /**
+     * Reference an existing Vector database with the given name. This is useful when you
+     * create a Vector database in one stage and want to share it in another. It avoids having to
+     * create a new Vector database in the other stage.
+     *
+     * :::tip
+     * You can use the `static get` method to share Vector databases across stages.
+     * :::
+     *
+     * @param name The name of the component.
+     * @param clusterID The RDS cluster id of the existing Vector database.
+     *
+     * @example
+     * Imagine you create a vector database  in the `dev` stage. And in your personal stage `frank`,
+     * instead of creating a new database, you want to share the same database from `dev`.
+     *
+     * ```ts title="sst.config.ts"
+     * const vector = $app.stage === "frank"
+     *   ? sst.aws.Vector.get("MyVectorDB", "app-dev-myvectordb")
+     *   : new sst.aws.Vector("MyVectorDB", {
+     *       dimension: 1536
+     *     });
+     * ```
+     *
+     * Here `app-dev-myvectordb` is the ID of the underlying Postgres cluster created in the `dev` stage.
+     * You can find this by outputting the cluster ID in the `dev` stage.
+     *
+     * ```ts title="sst.config.ts"
+     * return {
+     *   cluster: vector.clusterID
+     * };
+     * ```
+     *
+     * :::note
+     * The Vector component creates a Postgres cluster and lambda functions for interfacing with the VectorDB.
+     * The `static get` method only shares the underlying Postgres cluster. Each stage will have its own
+     * lambda functions.
+     * :::
+     */
+    static get(name: string, clusterID: Input<string>): Vector;
+    /**
+     * The ID of the RDS Postgres Cluster.
+     */
+    get clusterID(): import("@pulumi/pulumi").Output<string>;
+    /**
+     * The underlying [resources](/docs/components/#nodes) this component creates.
+     */
+    get nodes(): {
+        /**
+         * The Postgres database.
+         */
+        postgres: Postgres;
+    };
+    /** @internal */
+    getSSTLink(): {
+        properties: {
+            /** @internal */
+            queryFunction: import("@pulumi/pulumi").Output<string>;
+            /** @internal */
+            putFunction: import("@pulumi/pulumi").Output<string>;
+            /** @internal */
+            removeFunction: import("@pulumi/pulumi").Output<string>;
+        };
+        include: {
+            effect?: "allow" | "deny" | undefined;
+            actions: string[];
+            resources: Input<Input<string>[]>;
+            conditions?: Input<Input<{
+                test: Input<string>;
+                variable: Input<string>;
+                values: Input<Input<string>[]>;
+            }>[]> | undefined;
+            type: "aws.permission";
+        }[];
+    };
+}
+//# sourceMappingURL=vector.d.ts.map

package/platform/types/components/aws/vector.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vector.d.ts","sourceRoot":"","sources":["../../../../src/components/aws/vector.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,wBAAwB,EAAE,MAAM,gBAAgB,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,SAAS,EAAa,MAAM,iBAAiB,CAAC;AAClE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAG1D,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAClC,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAGpC,MAAM,WAAW,UAAU;IACzB;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACzB;;;OAGG;IACH,SAAS,CAAC,EAAE;QACV;;WAEG;QACH,QAAQ,CAAC,EAAE,SAAS,CAAC,YAAY,CAAC,CAAC;KACpC,CAAC;CACH;AAOD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,qBAAa,MAAO,SAAQ,SAAU,YAAW,IAAI,CAAC,QAAQ;IAC5D,OAAO,CAAC,QAAQ,CAAW;IAC3B,OAAO,CAAC,YAAY,CAAW;IAC/B,OAAO,CAAC,UAAU,CAAW;IAC7B,OAAO,CAAC,aAAa,CAAW;gBAEpB,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC,EAAE,wBAAwB;IA6H3E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;WACW,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC;IAQxD;;OAEG;IACH,IAAW,SAAS,4CAEnB;IAED;;OAEG;IACH,IAAW,KAAK;QAEZ;;WAEG;;MAGN;IAED,gBAAgB;IACT,UAAU;;YAGX,gBAAgB;;YAEhB,gBAAgB;;YAEhB,gBAAgB;;;;;;;;;;;;;;;CAevB"}

package/platform/types/components/aws/vpc-v1.d.ts

@@ -0,0 +1,208 @@
+import { ComponentResourceOptions, Output } from "@pulumi/pulumi";
+import { Component, Transform } from "../component";
+import { Input } from "../input";
+import { ec2 } from "@pulumi/aws";
+export interface VpcArgs {
+    /**
+     * Number of Availability Zones or AZs for the VPC. By default, it creates a VPC with 2
+     * AZs since services like RDS and Fargate need at least 2 AZs.
+     * @default `2`
+     * @example
+     * ```ts
+     * {
+     *   az: 3
+     * }
+     * ```
+     */
+    az?: Input<number>;
+    /**
+     * [Transform](/docs/components#transform) how this component creates its underlying
+     * resources.
+     */
+    transform?: {
+        /**
+         * Transform the EC2 VPC resource.
+         */
+        vpc?: Transform<ec2.VpcArgs>;
+        /**
+         * Transform the EC2 Internet Gateway resource.
+         */
+        internetGateway?: Transform<ec2.InternetGatewayArgs>;
+        /**
+         * Transform the EC2 NAT Gateway resource.
+         */
+        natGateway?: Transform<ec2.NatGatewayArgs>;
+        /**
+         * Transform the EC2 Elastic IP resource.
+         */
+        elasticIp?: Transform<ec2.EipArgs>;
+        /**
+         * Transform the EC2 Security Group resource.
+         */
+        securityGroup?: Transform<ec2.SecurityGroupArgs>;
+        /**
+         * Transform the EC2 public subnet resource.
+         */
+        publicSubnet?: Transform<ec2.SubnetArgs>;
+        /**
+         * Transform the EC2 private subnet resource.
+         */
+        privateSubnet?: Transform<ec2.SubnetArgs>;
+        /**
+         * Transform the EC2 route table resource for the public subnet.
+         */
+        publicRouteTable?: Transform<ec2.RouteTableArgs>;
+        /**
+         * Transform the EC2 route table resource for the private subnet.
+         */
+        privateRouteTable?: Transform<ec2.RouteTableArgs>;
+    };
+}
+/**
+ * The `Vpc` component lets you add a VPC to your app, but it has been deprecated because
+ * it does not support modifying the number of Availability Zones (AZs) after VPC creation.
+ *
+ * For existing usage, rename `sst.aws.Vpc` to `sst.aws.Vpc.v1`. For new VPCs, use
+ * the latest [`Vpc`](/docs/component/aws/vpc) component instead.
+ *
+ * :::caution
+ * This component has been deprecated.
+ * :::
+ *
+ * This creates a VPC with 2 Availability Zones by default. It also creates the following
+ * resources:
+ *
+ * 1. A security group.
+ * 2. A public subnet in each AZ.
+ * 3. A private subnet in each AZ.
+ * 4. An Internet Gateway, all the traffic from the public subnets are routed through it.
+ * 5. A NAT Gateway in each AZ. All the traffic from the private subnets are routed to the
+ *    NAT Gateway in the same AZ.
+ *
+ * :::note
+ * By default, this creates two NAT Gateways, one in each AZ. And it roughly costs $33 per
+ * NAT Gateway per month.
+ * :::
+ *
+ * NAT Gateways are billed per hour and per gigabyte of data processed. By default,
+ * this creates a NAT Gateway in each AZ. And this would be roughly $33 per NAT
+ * Gateway per month. Make sure to [review the pricing](https://aws.amazon.com/vpc/pricing/).
+ *
+ * @example
+ *
+ * #### Create a VPC
+ *
+ * ```ts title="sst.config.ts"
+ * new sst.aws.Vpc.v1("MyVPC");
+ * ```
+ *
+ * #### Create it with 3 Availability Zones
+ *
+ * ```ts title="sst.config.ts" {2}
+ * new sst.aws.Vpc.v1("MyVPC", {
+ *   az: 3
+ * });
+ * ```
+ */
+export declare class Vpc extends Component {
+    private vpc;
+    private internetGateway;
+    private securityGroup;
+    private natGateways;
+    private elasticIps;
+    private _publicSubnets;
+    private _privateSubnets;
+    private publicRouteTables;
+    private privateRouteTables;
+    constructor(name: string, args?: VpcArgs, opts?: ComponentResourceOptions);
+    /**
+     * The VPC ID.
+     */
+    get id(): Output<string>;
+    /**
+     * A list of public subnet IDs in the VPC.
+     */
+    get publicSubnets(): Output<Output<string>[]>;
+    /**
+     * A list of private subnet IDs in the VPC.
+     */
+    get privateSubnets(): Output<Output<string>[]>;
+    /**
+     * A list of VPC security group IDs.
+     */
+    get securityGroups(): Output<string>[];
+    /**
+     * The underlying [resources](/docs/components/#nodes) this component creates.
+     */
+    get nodes(): {
+        /**
+         * The Amazon EC2 VPC.
+         */
+        vpc: import("@pulumi/aws/ec2/vpc").Vpc;
+        /**
+         * The Amazon EC2 Internet Gateway.
+         */
+        internetGateway: import("@pulumi/aws/ec2/internetGateway").InternetGateway;
+        /**
+         * The Amazon EC2 Security Group.
+         */
+        securityGroup: import("@pulumi/aws/ec2/securityGroup").SecurityGroup;
+        /**
+         * The Amazon EC2 NAT Gateway.
+         */
+        natGateways: Output<import("@pulumi/aws/ec2/natGateway").NatGateway[]>;
+        /**
+         * The Amazon EC2 Elastic IP.
+         */
+        elasticIps: Output<import("@pulumi/aws/ec2/eip").Eip[]>;
+        /**
+         * The Amazon EC2 public subnet.
+         */
+        publicSubnets: Output<import("@pulumi/aws/ec2/subnet").Subnet[]>;
+        /**
+         * The Amazon EC2 private subnet.
+         */
+        privateSubnets: Output<import("@pulumi/aws/ec2/subnet").Subnet[]>;
+        /**
+         * The Amazon EC2 route table for the public subnet.
+         */
+        publicRouteTables: Output<import("@pulumi/aws/ec2/routeTable").RouteTable[]>;
+        /**
+         * The Amazon EC2 route table for the private subnet.
+         */
+        privateRouteTables: Output<import("@pulumi/aws/ec2/routeTable").RouteTable[]>;
+    };
+    /**
+     * Reference an existing VPC with the given ID. This is useful when you
+     * create a VPC in one stage and want to share it in another stage. It avoids having to
+     * create a new VPC in the other stage.
+     *
+     * :::tip
+     * You can use the `static get` method to share VPCs across stages.
+     * :::
+     *
+     * @param name The name of the component.
+     * @param vpcID The ID of the existing VPC.
+     *
+     * @example
+     * Imagine you create a VPC in the `dev` stage. And in your personal stage `frank`,
+     * instead of creating a new VPC, you want to share the VPC from `dev`.
+     *
+     * ```ts title="sst.config.ts"
+     * const vpc = $app.stage === "frank"
+     *   ? sst.aws.Vpc.v1.get("MyVPC", "vpc-0be8fa4de860618bb")
+     *   : new sst.aws.Vpc.v1("MyVPC");
+     * ```
+     *
+     * Here `vpc-0be8fa4de860618bb` is the ID of the VPC created in the `dev` stage.
+     * You can find this by outputting the VPC ID in the `dev` stage.
+     *
+     * ```ts title="sst.config.ts"
+     * return {
+     *   vpc: vpc.id
+     * };
+     * ```
+     */
+    static get(name: string, vpcID: Input<string>): Vpc;
+}
+//# sourceMappingURL=vpc-v1.d.ts.map

package/platform/types/components/aws/vpc-v1.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vpc-v1.d.ts","sourceRoot":"","sources":["../../../../src/components/aws/vpc-v1.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,EAAe,MAAM,gBAAgB,CAAC;AAC/E,OAAO,EAAE,SAAS,EAAE,SAAS,EAAa,MAAM,cAAc,CAAC;AAC/D,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,EAAE,GAAG,EAA8B,MAAM,aAAa,CAAC;AAE9D,MAAM,WAAW,OAAO;IACtB;;;;;;;;;;OAUG;IACH,EAAE,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACnB;;;OAGG;IACH,SAAS,CAAC,EAAE;QACV;;WAEG;QACH,GAAG,CAAC,EAAE,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC7B;;WAEG;QACH,eAAe,CAAC,EAAE,SAAS,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;QACrD;;WAEG;QACH,UAAU,CAAC,EAAE,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QAC3C;;WAEG;QACH,SAAS,CAAC,EAAE,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACnC;;WAEG;QACH,aAAa,CAAC,EAAE,SAAS,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QACjD;;WAEG;QACH,YAAY,CAAC,EAAE,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACzC;;WAEG;QACH,aAAa,CAAC,EAAE,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC1C;;WAEG;QACH,gBAAgB,CAAC,EAAE,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QACjD;;WAEG;QACH,iBAAiB,CAAC,EAAE,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;KACnD,CAAC;CACH;AAeD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,qBAAa,GAAI,SAAQ,SAAS;IAChC,OAAO,CAAC,GAAG,CAAU;IACrB,OAAO,CAAC,eAAe,CAAsB;IAC7C,OAAO,CAAC,aAAa,CAAoB;IACzC,OAAO,CAAC,WAAW,CAA2B;IAC9C,OAAO,CAAC,UAAU,CAAoB;IACtC,OAAO,CAAC,cAAc,CAAuB;IAC7C,OAAO,CAAC,eAAe,CAAuB;IAC9C,OAAO,CAAC,iBAAiB,CAA2B;IACpD,OAAO,CAAC,kBAAkB,CAA2B;gBAEzC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,wBAAwB;IAuPzE;;OAEG;IACH,IAAW,EAAE,mBAEZ;IAED;;OAEG;IACH,IAAW,aAAa,6BAIvB;IAED;;OAEG;IACH,IAAW,cAAc,6BAIxB;IAED;;OAEG;IACH,IAAW,cAAc,qBAExB;IAED;;OAEG;IACH,IAAW,KAAK;QAEZ;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;MAGN;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;WACW,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC;CAyFrD"}