@sst-community/sst 4.21.1 → 5.0.0-alpha.2

package/platform/types/components/aws/v5/aurora.d.ts

@@ -0,0 +1,459 @@
+import { ComponentResourceOptions, Output } from "@pulumi/pulumi";
+import { type LinkInclude, V5Args } from "../../parts-component";
+import type { Input } from "../../input";
+import { type ProxyArgs } from "../helpers/rds";
+import { RdsRoleLookup } from "../providers/rds-role-lookup";
+import { type TakesVpc } from "../helpers/vpc";
+import type { AuroraArgs as OriginalAuroraArgs } from "../aurora";
+declare const parts: {
+    /**
+     * The random password of the master user. It's created when you don't set a `password`.
+     */
+    password: import("../..").OptionalPart<typeof import("@pulumi/random/randomPassword").RandomPassword>;
+    /**
+     * The Secrets Manager secret that stores the master user's username and password.
+     */
+    secret: typeof import("@pulumi/aws/secretsmanager/secret").Secret;
+    /**
+     * The version of the secret holding the current username and password.
+     */
+    secretVersion: typeof import("@pulumi/aws/secretsmanager/secretVersion").SecretVersion;
+    /**
+     * The RDS subnet group.
+     */
+    subnetGroup: typeof import("@pulumi/aws/rds/subnetGroup").SubnetGroup;
+    /**
+     * The RDS instance parameter group.
+     */
+    instanceParameterGroup: typeof import("@pulumi/aws/rds/parameterGroup").ParameterGroup;
+    /**
+     * The RDS cluster parameter group.
+     */
+    clusterParameterGroup: typeof import("@pulumi/aws/rds/clusterParameterGroup").ClusterParameterGroup;
+    /**
+     * The RDS Cluster.
+     */
+    cluster: typeof import("@pulumi/aws/rds/cluster").Cluster;
+    /**
+     * The primary database instance in the RDS Cluster.
+     */
+    instance: typeof import("@pulumi/aws/rds/clusterInstance").ClusterInstance;
+    /**
+     * The read-only replicas in the RDS Cluster, by number, from `0`.
+     */
+    replica: import("../..").ManyPart<typeof import("@pulumi/aws/rds/clusterInstance").ClusterInstance>;
+    /**
+     * The secrets that store the additional credentials the proxy can use, by username.
+     */
+    proxySecret: import("../..").ManyPart<typeof import("@pulumi/aws/secretsmanager/secret").Secret>;
+    /**
+     * The versions of the secrets holding the additional credentials, by username.
+     */
+    proxySecretVersion: import("../..").ManyPart<typeof import("@pulumi/aws/secretsmanager/secretVersion").SecretVersion>;
+    /**
+     * The IAM role that lets the proxy read the secrets.
+     */
+    proxyRole: import("../..").OptionalPart<typeof import("@pulumi/aws/iam/role").Role>;
+    /**
+     * Waits for the service-linked role RDS needs before the proxy is created.
+     */
+    proxyRoleLookup: import("../..").OptionalPart<typeof RdsRoleLookup>;
+    /**
+     * The RDS Proxy. For a cluster referenced with `get`, it's added once the
+     * cluster's tags are read.
+     */
+    proxy: import("../..").OptionalPart<typeof import("@pulumi/aws/rds/proxy").Proxy>;
+    /**
+     * The proxy's default target group.
+     */
+    proxyTargetGroup: import("../..").OptionalPart<typeof import("@pulumi/aws/rds/proxyDefaultTargetGroup").ProxyDefaultTargetGroup>;
+    /**
+     * The proxy's target: the cluster.
+     */
+    proxyTarget: import("../..").OptionalPart<typeof import("@pulumi/aws/rds/proxyTarget").ProxyTarget>;
+};
+export interface AuroraArgs extends V5Args<TakesVpc<Omit<OriginalAuroraArgs, "proxy" | "replicas">>, typeof parts> {
+    /**
+     * The number of read-only Aurora replicas to create.
+     *
+     * By default, the cluster has one primary DB instance that is used for both writes and
+     * reads. You can add up to 15 read-only replicas to offload the read traffic from the
+     * primary instance.
+     *
+     * This has to be a plain value.
+     *
+     * @default `0`
+     * @example
+     * ```js
+     * {
+     *   replicas: 2
+     * }
+     * ```
+     */
+    replicas?: number;
+    /**
+     * Enable [RDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.html)
+     * for the database.
+     *
+     * Amazon RDS Proxy sits between your application and the database and manages connections to
+     * it. It's useful for serverless applications, or Lambda functions where each invocation
+     * might create a new connection.
+     *
+     * There's an [extra cost](#cost) attached to enabling this. Check out the [RDS Proxy
+     * pricing](https://aws.amazon.com/rds/proxy/pricing/) for more details.
+     *
+     * Whether there is a proxy has to be a plain value.
+     *
+     * @default `false`
+     * @example
+     * ```js
+     * {
+     *   proxy: true
+     * }
+     * ```
+     */
+    proxy?: boolean | ProxyArgs;
+}
+declare const Aurora_base: import("../..").ComponentClass<{
+    /**
+     * The random password of the master user. It's created when you don't set a `password`.
+     */
+    password: import("../..").OptionalPart<typeof import("@pulumi/random/randomPassword").RandomPassword>;
+    /**
+     * The Secrets Manager secret that stores the master user's username and password.
+     */
+    secret: typeof import("@pulumi/aws/secretsmanager/secret").Secret;
+    /**
+     * The version of the secret holding the current username and password.
+     */
+    secretVersion: typeof import("@pulumi/aws/secretsmanager/secretVersion").SecretVersion;
+    /**
+     * The RDS subnet group.
+     */
+    subnetGroup: typeof import("@pulumi/aws/rds/subnetGroup").SubnetGroup;
+    /**
+     * The RDS instance parameter group.
+     */
+    instanceParameterGroup: typeof import("@pulumi/aws/rds/parameterGroup").ParameterGroup;
+    /**
+     * The RDS cluster parameter group.
+     */
+    clusterParameterGroup: typeof import("@pulumi/aws/rds/clusterParameterGroup").ClusterParameterGroup;
+    /**
+     * The RDS Cluster.
+     */
+    cluster: typeof import("@pulumi/aws/rds/cluster").Cluster;
+    /**
+     * The primary database instance in the RDS Cluster.
+     */
+    instance: typeof import("@pulumi/aws/rds/clusterInstance").ClusterInstance;
+    /**
+     * The read-only replicas in the RDS Cluster, by number, from `0`.
+     */
+    replica: import("../..").ManyPart<typeof import("@pulumi/aws/rds/clusterInstance").ClusterInstance>;
+    /**
+     * The secrets that store the additional credentials the proxy can use, by username.
+     */
+    proxySecret: import("../..").ManyPart<typeof import("@pulumi/aws/secretsmanager/secret").Secret>;
+    /**
+     * The versions of the secrets holding the additional credentials, by username.
+     */
+    proxySecretVersion: import("../..").ManyPart<typeof import("@pulumi/aws/secretsmanager/secretVersion").SecretVersion>;
+    /**
+     * The IAM role that lets the proxy read the secrets.
+     */
+    proxyRole: import("../..").OptionalPart<typeof import("@pulumi/aws/iam/role").Role>;
+    /**
+     * Waits for the service-linked role RDS needs before the proxy is created.
+     */
+    proxyRoleLookup: import("../..").OptionalPart<typeof RdsRoleLookup>;
+    /**
+     * The RDS Proxy. For a cluster referenced with `get`, it's added once the
+     * cluster's tags are read.
+     */
+    proxy: import("../..").OptionalPart<typeof import("@pulumi/aws/rds/proxy").Proxy>;
+    /**
+     * The proxy's default target group.
+     */
+    proxyTargetGroup: import("../..").OptionalPart<typeof import("@pulumi/aws/rds/proxyDefaultTargetGroup").ProxyDefaultTargetGroup>;
+    /**
+     * The proxy's target: the cluster.
+     */
+    proxyTarget: import("../..").OptionalPart<typeof import("@pulumi/aws/rds/proxyTarget").ProxyTarget>;
+}>;
+/**
+ * The `Aurora` component lets you add a Aurora Postgres or MySQL cluster to your app
+ * using [Amazon Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html).
+ *
+ * It takes the same args as [`sst.aws.Aurora`](/docs/component/aws/aurora) and creates the same
+ * resources. It's built from parts, so every resource it creates can be transformed, is
+ * available in `nodes`, and can be swapped for one you already have.
+ *
+ * @example
+ *
+ * #### Create an Aurora Postgres cluster
+ *
+ * ```js title="sst.config.ts"
+ * const vpc = new sst.aws.Vpc("MyVpc");
+ * const database = new sst.aws.v5.Aurora("MyDatabase", {
+ *   engine: "postgres",
+ *   vpc
+ * });
+ * ```
+ *
+ * #### Create an Aurora MySQL cluster
+ *
+ * ```js title="sst.config.ts"
+ * const vpc = new sst.aws.Vpc("MyVpc");
+ * const database = new sst.aws.v5.Aurora("MyDatabase", {
+ *   engine: "mysql",
+ *   vpc
+ * });
+ * ```
+ *
+ * #### Change the scaling config
+ *
+ * ```js title="sst.config.ts"
+ * new sst.aws.v5.Aurora("MyDatabase", {
+ *   engine: "postgres",
+ *   scaling: {
+ *     min: "2 ACU",
+ *     max: "128 ACU"
+ *   },
+ *   vpc
+ * });
+ * ```
+ *
+ * #### Link to a resource
+ *
+ * You can link your database to other resources, like a function or your Next.js app.
+ *
+ * ```ts title="sst.config.ts"
+ * new sst.aws.Nextjs("MyWeb", {
+ *   link: [database],
+ *   vpc
+ * });
+ * ```
+ *
+ * Once linked, you can connect to it from your function code.
+ *
+ * ```ts title="app/page.tsx" {1,5-9}
+ * import { Resource } from "sst";
+ * import postgres from "postgres";
+ *
+ * const sql = postgres({
+ *   username: Resource.MyDatabase.username,
+ *   password: Resource.MyDatabase.password,
+ *   database: Resource.MyDatabase.database,
+ *   host: Resource.MyDatabase.host,
+ *   port: Resource.MyDatabase.port
+ * });
+ * ```
+ *
+ * #### Enable the RDS Data API
+ *
+ * ```ts title="sst.config.ts"
+ * new sst.aws.v5.Aurora("MyDatabase", {
+ *   engine: "postgres",
+ *   dataApi: true,
+ *   vpc
+ * });
+ * ```
+ *
+ * When using the Data API, connecting to the database does not require a persistent
+ * connection, and works over HTTP. You also don't need the `sst tunnel` or a VPN to connect
+ * to it from your local machine.
+ *
+ * ```ts title="app/page.tsx" {1,6,7,8}
+ * import { Resource } from "sst";
+ * import { drizzle } from "drizzle-orm/aws-data-api/pg";
+ * import { RDSDataClient } from "@aws-sdk/client-rds-data";
+ *
+ * drizzle(new RDSDataClient({}), {
+ *   database: Resource.MyDatabase.database,
+ *   secretArn: Resource.MyDatabase.secretArn,
+ *   resourceArn: Resource.MyDatabase.clusterArn
+ * });
+ * ```
+ *
+ * #### Running locally
+ *
+ * By default, your Aurora database is deployed in `sst dev`. But let's say you are running
+ * Postgres locally.
+ *
+ * ```bash
+ * docker run \
+ *   --rm \
+ *   -p 5432:5432 \
+ *   -v $(pwd)/.sst/storage/postgres:/var/lib/postgresql/data \
+ *   -e POSTGRES_USER=postgres \
+ *   -e POSTGRES_PASSWORD=password \
+ *   -e POSTGRES_DB=local \
+ *   postgres:17
+ * ```
+ *
+ * You can connect to it in `sst dev` by configuring the `dev` prop.
+ *
+ * ```ts title="sst.config.ts" {4-9}
+ * new sst.aws.v5.Aurora("MyDatabase", {
+ *   engine: "postgres",
+ *   vpc,
+ *   dev: {
+ *     username: "postgres",
+ *     password: "password",
+ *     database: "local",
+ *     port: 5432
+ *   }
+ * });
+ * ```
+ *
+ * This will skip deploying the database and link to the locally running Postgres database
+ * instead.
+ *
+ * #### Switch from `sst.aws.Aurora`
+ *
+ * Change `sst.aws.Aurora` to `sst.aws.v5.Aurora` and keep the name. The cluster you've
+ * deployed is kept, and so is everything around it: its instances, password, secrets,
+ * parameter groups and proxy.
+ *
+ * ```ts title="sst.config.ts" del={1} ins={2}
+ * const database = new sst.aws.Aurora("MyDatabase", { engine: "postgres", vpc });
+ * const database = new sst.aws.v5.Aurora("MyDatabase", { engine: "postgres", vpc });
+ * ```
+ *
+ * A few things are written differently:
+ *
+ * - `replicas`, `proxy`, its list of `credentials`, and each credential's `username` are
+ *   plain values, not outputs. They decide which resources are created.
+ * - `nodes` has every resource, not only the cluster and the instance. The secret that
+ *   stores the master user's credentials is `nodes.secret`.
+ * - `transform.instance` still applies to the primary instance and to each replica. To
+ *   change only the replicas, use `transform.replica`, which is applied after it.
+ * - If you set `tags` on the cluster with an object in `transform`, it keeps the tags SST
+ *   sets next to yours. They're added back when you switch.
+ *
+ * ---
+ *
+ * ### Cost
+ *
+ * This component has one DB instance that is used for both writes and reads. The
+ * instance can scale from the minimum number of ACUs to the maximum number of ACUs. By default,
+ * this uses a `min` of 0 ACUs and a `max` of 4 ACUs.
+ *
+ * When the database is paused, you are not charged for the ACUs.
+ *
+ * Each ACU costs $0.12 per hour for both `postgres` and `mysql` engine. The storage costs
+ * $0.01 per GB per month for standard storage.
+ *
+ * So if your database is constantly using 1GB of memory or 0.5 ACUs, then you are charged
+ * $0.12 x 0.5 x 24 x 30 or **$43 per month**. And add the storage costs to this as well.
+ *
+ * The above are rough estimates for _us-east-1_, check out the
+ * [Amazon Aurora pricing](https://aws.amazon.com/rds/aurora/pricing) for more details.
+ *
+ * #### RDS Proxy
+ *
+ * If you enable the `proxy`, it uses _Aurora Capacity Units_ with a minumum of 8 ACUs at
+ * $0.015 per ACU hour.
+ *
+ * That works out to an **additional** $0.015 x 8 x 24 x 30 or **$86 per month**. Adjust
+ * this if you end up using more than 8 ACUs.
+ *
+ * The above are rough estimates for _us-east-1_, check out the
+ * [RDS Proxy pricing](https://aws.amazon.com/rds/proxy/pricing/) for more details.
+ *
+ * #### RDS Data API
+ *
+ * If you enable `dataApi`, you get charged an **additional** $0.35 per million requests for
+ * the first billion requests. After that, it's $0.20 per million requests.
+ *
+ * Check out the [RDS Data API pricing](https://aws.amazon.com/rds/aurora/pricing/#Data_API_costs)
+ * for more details.
+ */
+export declare class Aurora extends Aurora_base {
+    private connection;
+    constructor(name: string, args: AuroraArgs, opts?: ComponentResourceOptions);
+    /**
+     * The ID of the RDS Cluster.
+     */
+    get id(): Output<string>;
+    /**
+     * The ARN of the RDS Cluster.
+     */
+    get clusterArn(): Output<string>;
+    /**
+     * The ARN of the master user secret.
+     */
+    get secretArn(): Output<string>;
+    /** The username of the master user. */
+    get username(): Output<string>;
+    /** The password of the master user. */
+    get password(): Output<string>;
+    /**
+     * The name of the database.
+     */
+    get database(): Output<string>;
+    /**
+     * The port of the database.
+     */
+    get port(): import("@pulumi/pulumi").OutputInstance<number>;
+    /**
+     * The host of the database.
+     */
+    get host(): Output<string>;
+    /**
+     * The reader endpoint of the database.
+     */
+    get reader(): Output<string>;
+    /**
+     * Linking a database gives the linked resource what it needs to connect:
+     * the host, port, database, username and password, and the ARNs of the
+     * cluster and its secret for the RDS Data API.
+     */
+    link(): {
+        properties: {
+            clusterArn: Output<string>;
+            secretArn: Output<string>;
+            database: Output<string>;
+            username: Output<string>;
+            password: Output<string>;
+            port: import("@pulumi/pulumi").OutputInstance<number>;
+            host: Output<string>;
+            reader: Output<string | undefined>;
+        };
+        include: LinkInclude[];
+    };
+    /**
+     * Reference an existing Aurora cluster with its RDS cluster ID. This is useful when you
+     * create a Aurora cluster in one stage and want to share it in another. It avoids having to
+     * create a new Aurora cluster in the other stage.
+     *
+     * :::tip
+     * You can use the `static get` method to share Aurora clusters across stages.
+     * :::
+     *
+     * @param name The name of the component.
+     * @param id The ID of the existing Aurora cluster.
+     * @param opts Resource options.
+     *
+     * @example
+     * Imagine you create a cluster in the `dev` stage. And in your personal stage `frank`,
+     * instead of creating a new cluster, you want to share the same cluster from `dev`.
+     *
+     * ```ts title="sst.config.ts"
+     * const database = $app.stage === "frank"
+     *   ? sst.aws.v5.Aurora.get("MyDatabase", "app-dev-mydatabase")
+     *   : new sst.aws.v5.Aurora("MyDatabase", { engine: "postgres", vpc });
+     * ```
+     *
+     * Here `app-dev-mydatabase` is the ID of the 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 database.id;
+     * ```
+     */
+    static get(name: string, id: Input<string>, opts?: ComponentResourceOptions): Aurora;
+}
+export {};
+//# sourceMappingURL=aurora.d.ts.map

package/platform/types/components/aws/v5/aurora.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"aurora.d.ts","sourceRoot":"","sources":["../../../../../src/components/aws/v5/aurora.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,wBAAwB,EAGxB,MAAM,EAEP,MAAM,gBAAgB,CAAC;AAGxB,OAAO,EACL,KAAK,WAAW,EAChB,MAAM,EAIP,MAAM,uBAAuB,CAAC;AAE/B,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAKzC,OAAO,EAGL,KAAK,SAAS,EAIf,MAAM,gBAAgB,CAAC;AAExB,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAE,KAAK,QAAQ,EAAS,MAAM,gBAAgB,CAAC;AACtD,OAAO,KAAK,EAAE,UAAU,IAAI,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAElE,QAAA,MAAM,KAAK;IACT;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;;OAGG;;IAEH;;OAEG;;IAEH;;OAEG;;CAEJ,CAAC;AAEF,MAAM,WAAW,UACf,SAAQ,MAAM,CACZ,QAAQ,CAAC,IAAI,CAAC,kBAAkB,EAAE,OAAO,GAAG,UAAU,CAAC,CAAC,EACxD,OAAO,KAAK,CACb;IACD;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC7B;;IAhHC;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;;OAGG;;IAEH;;OAEG;;IAEH;;OAEG;;;AAuEL;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4LG;AACH,qBAAa,MAAO,SAAQ,WAAkC;IAC5D,OAAO,CAAC,UAAU,CAAa;gBAEnB,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC,EAAE,wBAAwB;IAwW3E;;OAEG;IACH,IAAW,EAAE,mBAEZ;IAED;;OAEG;IACH,IAAW,UAAU,mBAEpB;IAED;;OAEG;IACH,IAAW,SAAS,mBAEnB;IAED,uCAAuC;IACvC,IAAW,QAAQ,mBAElB;IAED,uCAAuC;IACvC,IAAW,QAAQ,mBAElB;IAED;;OAEG;IACH,IAAW,QAAQ,mBAElB;IAED;;OAEG;IACH,IAAW,IAAI,oDAEd;IAED;;OAEG;IACH,IAAW,IAAI,mBAEd;IAED;;OAEG;IACH,IAAW,MAAM,mBAUhB;IAED;;;;OAIG;IACI,IAAI;;;;;;;;;;;;;IAsBX;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;WACW,GAAG,CACf,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,KAAK,CAAC,MAAM,CAAC,EACjB,IAAI,CAAC,EAAE,wBAAwB;CAIlC"}