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

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

@@ -0,0 +1,453 @@
+import { ComponentResourceOptions } from "@pulumi/pulumi";
+import { ComponentArgs } from "../../parts-component";
+import type { Input } from "../../input";
+import { type DurationDays } from "../../duration";
+import { type AnyVpc } from "../helpers/vpc";
+declare const parts: {
+    /**
+     * The DSQL cluster.
+     */
+    cluster: typeof import("@pulumi/aws/dsql/cluster").Cluster;
+    /**
+     * The peer DSQL cluster, in the peer region. Multi-region only.
+     */
+    peerCluster: import("../..").OptionalPart<typeof import("@pulumi/aws/dsql/cluster").Cluster>;
+    /**
+     * The peering that tells the cluster about its peer. Multi-region only.
+     */
+    clusterPeering: import("../..").OptionalPart<typeof import("@pulumi/aws/dsql/clusterPeering").ClusterPeering>;
+    /**
+     * The peering that tells the peer cluster about the cluster, in the peer region.
+     * Multi-region only.
+     */
+    peerClusterPeering: import("../..").OptionalPart<typeof import("@pulumi/aws/dsql/clusterPeering").ClusterPeering>;
+    /**
+     * The EC2 security group for the DSQL VPC endpoints.
+     */
+    endpointSecurityGroup: import("../..").NamedPart<import("../..").OptionalPart<typeof import("@pulumi/aws/ec2/securityGroup").SecurityGroup>>;
+    /**
+     * The EC2 VPC endpoint for DSQL management operations.
+     */
+    managementEndpoint: import("../..").OptionalPart<typeof import("@pulumi/aws/ec2/vpcEndpoint").VpcEndpoint>;
+    /**
+     * The EC2 VPC endpoint for DSQL connections.
+     */
+    connectionEndpoint: import("../..").OptionalPart<typeof import("@pulumi/aws/ec2/vpcEndpoint").VpcEndpoint>;
+    /**
+     * The IAM role AWS Backup uses to back up the cluster.
+     */
+    backupRole: import("../..").OptionalPart<typeof import("@pulumi/aws/iam/role").Role>;
+    /**
+     * The AWS Backup vault.
+     */
+    backupVault: import("../..").OptionalPart<typeof import("@pulumi/aws/backup/vault").Vault>;
+    /**
+     * The AWS Backup vault in the peer region, which the backups are copied to.
+     * Multi-region only.
+     */
+    peerBackupVault: import("../..").OptionalPart<typeof import("@pulumi/aws/backup/vault").Vault>;
+    /**
+     * The AWS Backup plan.
+     */
+    backupPlan: import("../..").OptionalPart<typeof import("@pulumi/aws/backup/plan").Plan>;
+    /**
+     * The AWS Backup selection.
+     */
+    backupSelection: import("../..").OptionalPart<typeof import("@pulumi/aws/backup/selection").Selection>;
+};
+export interface DsqlArgs extends ComponentArgs<typeof parts> {
+    /**
+     * Configure multi-region cluster peering.
+     *
+     * Creates a cluster in the current region and a peer cluster in another region,
+     * linked via a witness region. The witness must differ from both cluster regions.
+     *
+     * Learn more about [AWS DSQL regions](https://docs.aws.amazon.com/aurora-dsql/latest/userguide/what-is-aurora-dsql.html#region-availability).
+     *
+     * Whether the cluster is multi-region, and its peer region, have to be plain values.
+     *
+     * @example
+     *
+     * ```ts
+     * const cluster = new sst.aws.v5.Dsql("MyCluster", {
+     *   regions: {
+     *     witness: "us-west-2",
+     *     peer: "us-east-2"
+     *   }
+     * });
+     * ```
+     */
+    regions?: {
+        /** The witness region. Must differ from both cluster regions. */
+        witness: Input<string>;
+        /** The AWS region for the peer cluster. */
+        peer: string;
+    };
+    /**
+     * Configure automatic backups for the cluster using AWS Backup.
+     *
+     * Set to `true` to use the defaults, or pass an object to customize the schedule and retention.
+     *
+     * :::tip
+     * If multi-region is enabled, backups are scheduled in the current region and
+     * copied to the peer region.
+     * :::
+     *
+     * Omit or set to `false` to skip backup creation entirely.
+     *
+     * @example
+     * Enable with defaults (daily at 5 AM UTC, 7-day retention).
+     * ```ts title="sst.config.ts"
+     * const cluster = new sst.aws.v5.Dsql("MyCluster", {
+     *   backup: true
+     * });
+     * ```
+     *
+     * Custom schedule and retention.
+     * ```ts title="sst.config.ts"
+     * const cluster = new sst.aws.v5.Dsql("MyCluster", {
+     *   backup: {
+     *     schedule: "cron(0 2 ? * * *)",
+     *     retention: "90 days"
+     *   }
+     * });
+     * ```
+     */
+    backup?: boolean | {
+        /**
+         * The schedule for the backups as an [AWS Backup cron expression](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BackupRule.html).
+         *
+         * This uses the same 6-field `cron(...)` format as EventBridge and is evaluated in UTC.
+         *
+         * @default `"cron(0 5 ? * * *)"`
+         * @example
+         * Back up every day at midnight UTC.
+         * ```ts
+         * schedule: "cron(0 0 ? * * *)"
+         * ```
+         *
+         * Back up every Monday at 3 AM UTC.
+         * ```ts
+         * schedule: "cron(0 3 ? * MON *)"
+         * ```
+         */
+        schedule?: Input<string>;
+        /**
+         * How long to retain backups. Use a day duration like `"7 days"`.
+         * @default `"7 days"`
+         */
+        retention?: Input<DurationDays>;
+    };
+    /**
+     * Create AWS PrivateLink interface endpoints in a VPC for private connectivity.
+     * This allows lambdas placed inside a VPC without NAT gateways to connect to the DSQL instance.
+     *
+     * :::note
+     * Currently only single region VPC is supported.
+     * :::
+     *
+     * @example
+     *
+     * ```ts title="sst.config.ts"
+     * const myVpc = new sst.aws.Vpc("MyVpc");
+     *
+     * const cluster = new sst.aws.v5.Dsql("MyCluster", {
+     *   vpc: myVpc
+     * });
+     * ```
+     *
+     * #### Customize VPC endpoints
+     *
+     * ```ts title="sst.config.ts"
+     * const myVpc = new sst.aws.Vpc("MyVpc");
+     *
+     * const cluster = new sst.aws.v5.Dsql("MyCluster", {
+     *   vpc: {
+     *     instance: myVpc,
+     *     endpoints: {
+     *       management: true,
+     *       connection: true,
+     *     }
+     *   }
+     * });
+     * ```
+     */
+    vpc?: AnyVpc | {
+        /** The VPC to create the endpoints in. */
+        instance: AnyVpc;
+        endpoints?: {
+            /**
+             * Endpoint for control plane ops (create, get, update, delete clusters).
+             *
+             * @default `false`
+             */
+            management?: boolean;
+            /**
+             * Endpoint for PostgreSQL client connections.
+             *
+             * @default `true`
+             */
+            connection?: boolean;
+        };
+    };
+}
+declare const Dsql_base: import("../..").ComponentClass<{
+    /**
+     * The DSQL cluster.
+     */
+    cluster: typeof import("@pulumi/aws/dsql/cluster").Cluster;
+    /**
+     * The peer DSQL cluster, in the peer region. Multi-region only.
+     */
+    peerCluster: import("../..").OptionalPart<typeof import("@pulumi/aws/dsql/cluster").Cluster>;
+    /**
+     * The peering that tells the cluster about its peer. Multi-region only.
+     */
+    clusterPeering: import("../..").OptionalPart<typeof import("@pulumi/aws/dsql/clusterPeering").ClusterPeering>;
+    /**
+     * The peering that tells the peer cluster about the cluster, in the peer region.
+     * Multi-region only.
+     */
+    peerClusterPeering: import("../..").OptionalPart<typeof import("@pulumi/aws/dsql/clusterPeering").ClusterPeering>;
+    /**
+     * The EC2 security group for the DSQL VPC endpoints.
+     */
+    endpointSecurityGroup: import("../..").NamedPart<import("../..").OptionalPart<typeof import("@pulumi/aws/ec2/securityGroup").SecurityGroup>>;
+    /**
+     * The EC2 VPC endpoint for DSQL management operations.
+     */
+    managementEndpoint: import("../..").OptionalPart<typeof import("@pulumi/aws/ec2/vpcEndpoint").VpcEndpoint>;
+    /**
+     * The EC2 VPC endpoint for DSQL connections.
+     */
+    connectionEndpoint: import("../..").OptionalPart<typeof import("@pulumi/aws/ec2/vpcEndpoint").VpcEndpoint>;
+    /**
+     * The IAM role AWS Backup uses to back up the cluster.
+     */
+    backupRole: import("../..").OptionalPart<typeof import("@pulumi/aws/iam/role").Role>;
+    /**
+     * The AWS Backup vault.
+     */
+    backupVault: import("../..").OptionalPart<typeof import("@pulumi/aws/backup/vault").Vault>;
+    /**
+     * The AWS Backup vault in the peer region, which the backups are copied to.
+     * Multi-region only.
+     */
+    peerBackupVault: import("../..").OptionalPart<typeof import("@pulumi/aws/backup/vault").Vault>;
+    /**
+     * The AWS Backup plan.
+     */
+    backupPlan: import("../..").OptionalPart<typeof import("@pulumi/aws/backup/plan").Plan>;
+    /**
+     * The AWS Backup selection.
+     */
+    backupSelection: import("../..").OptionalPart<typeof import("@pulumi/aws/backup/selection").Selection>;
+}>;
+/**
+ * The `Dsql` component lets you add an [Amazon Aurora DSQL](https://aws.amazon.com/rds/aurora/dsql/) cluster to your app.
+ *
+ * It takes the same args as [`sst.aws.Dsql`](/docs/component/aws/dsql) 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
+ *
+ * #### Single-region cluster
+ *
+ * ```ts title="sst.config.ts"
+ * const cluster = new sst.aws.v5.Dsql("MyCluster");
+ * ```
+ *
+ * Once linked, you can connect to it from your function code.
+ *
+ * ```ts title="src/lambda.ts"
+ * import { Resource } from "sst";
+ * import { AuroraDSQLClient } from "@aws/aurora-dsql-node-postgres-connector";
+ *
+ * const client = new AuroraDSQLClient({
+ *   host: Resource.MyCluster.endpoint,
+ *   user: "admin",
+ * });
+ *
+ * await client.connect();
+ * const result = await client.query("SELECT NOW() as now");
+ * await client.end();
+ * ```
+ *
+ * #### Multi-region cluster
+ *
+ * ```ts title="sst.config.ts"
+ * const cluster = new sst.aws.v5.Dsql("MyCluster", {
+ *   regions: {
+ *     witness: "us-west-2",
+ *     peer: "us-east-2"
+ *   }
+ * });
+ * ```
+ *
+ * #### With private VPC endpoints
+ *
+ * ```ts title="sst.config.ts"
+ * const vpc = new sst.aws.Vpc("MyVpc");
+ *
+ * const cluster = new sst.aws.v5.Dsql("MyCluster", {
+ *   vpc: {
+ *     instance: vpc,
+ *     endpoints: { connection: true }
+ *   }
+ * });
+ * ```
+ *
+ * #### With backups
+ *
+ * ```ts title="sst.config.ts"
+ * const cluster = new sst.aws.v5.Dsql("MyCluster", {
+ *   backup: true
+ * });
+ * ```
+ *
+ * #### Link to a function
+ *
+ * ```ts title="sst.config.ts"
+ * new sst.aws.v5.Function("MyFunction", {
+ *   handler: "src/lambda.handler",
+ *   link: [cluster]
+ * });
+ * ```
+ *
+ * #### Switch from `sst.aws.Dsql`
+ *
+ * Change `sst.aws.Dsql` to `sst.aws.v5.Dsql` and keep the name. The cluster you've
+ * deployed is kept, and so is everything around it: its peer, VPC endpoints and backups.
+ *
+ * ```ts title="sst.config.ts" del={1} ins={2}
+ * const cluster = new sst.aws.Dsql("MyCluster");
+ * const cluster = new sst.aws.v5.Dsql("MyCluster");
+ * ```
+ *
+ * A few things are written differently:
+ *
+ * - `regions.peer` is a plain value, not an output. It decides which region the peer's
+ *   resources are created in.
+ * - `nodes` has every resource, not only the two clusters. Each can be transformed, the
+ *   two sides of the peering and the backup role included.
+ * - `transform.backupVault` still applies to the vault in the peer region as well. To
+ *   change only that one, use `transform.peerBackupVault`, which is applied after it.
+ *   A function that told the two apart by name now gets `MyClusterPeerBackupVault` for
+ *   the peer's.
+ * - If you set `multiRegionProperties` on the cluster with an object in `transform`, it
+ *   keeps its witness region.
+ *
+ * ---
+ *
+ * ### Cost
+ *
+ * Aurora DSQL is serverless and uses a pay-per-use pricing model. You are charged for
+ * database activity measured in _Distributed Processing Units_ (DPUs) at $8 per million
+ * DPUs, and storage at $0.33 per GB-month. When idle, usage scales to zero and you incur
+ * no DPU charges.
+ *
+ * There is a free tier of 100,000 DPUs and 1 GB of storage per month.
+ *
+ * For example, a single-region cluster averaging 1.3M DPUs per month with 15 GB of storage
+ * costs roughly 1.3 x $8 + 15 x $0.33 or **$15 per month**.
+ *
+ * Check out the [Aurora DSQL pricing](https://aws.amazon.com/rds/aurora/dsql/pricing/) for more details.
+ */
+export declare class Dsql extends Dsql_base {
+    constructor(name: string, args?: DsqlArgs, opts?: ComponentResourceOptions);
+    /** The region of the cluster. */
+    get region(): import("@pulumi/pulumi").Output<string>;
+    /** The endpoint of the cluster. */
+    get endpoint(): import("@pulumi/pulumi").Output<string>;
+    /**
+     * The peer cluster info. Only available for multi-region clusters.
+     *
+     * @example
+     * ```ts title="sst.config.ts"
+     * const cluster = new sst.aws.v5.Dsql("MyCluster", {
+     *   regions: { witness: "us-west-2", peer: "us-east-2" },
+     * });
+     *
+     * return {
+     *   peerRegion: cluster.peer.region,
+     *   peerEndpoint: cluster.peer.endpoint,
+     * };
+     * ```
+     */
+    get peer(): {
+        /** The region of the peer cluster. */
+        region: import("@pulumi/pulumi").Output<string>;
+        /** The endpoint of the peer cluster. */
+        endpoint: import("@pulumi/pulumi").Output<string>;
+    };
+    /**
+     * Linking a cluster gives the linked resource its region and endpoint, and its
+     * peer's when it has one. It also lets the resource connect to the cluster.
+     */
+    link(): {
+        properties: {
+            region: import("@pulumi/pulumi").Output<string>;
+            endpoint: import("@pulumi/pulumi").Output<string>;
+            peer: {
+                /** The region of the peer cluster. */
+                region: import("@pulumi/pulumi").Output<string>;
+                /** The endpoint of the peer cluster. */
+                endpoint: import("@pulumi/pulumi").Output<string>;
+            } | undefined;
+        };
+        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";
+        }[];
+    };
+    /**
+     * Reference an existing DSQL cluster by identifier. Useful for sharing a cluster
+     * across stages without creating a new one.
+     *
+     * :::tip
+     * You can use the `static get` method to share a cluster across stages.
+     * :::
+     *
+     * @param name The name of the component.
+     * @param args The identifier of the cluster, and of its peer when it has one.
+     * @param opts Component resource options.
+     *
+     * @example
+     *
+     * #### Single-region cluster
+     *
+     * ```ts title="sst.config.ts"
+     * const cluster = $app.stage === "frank"
+     *   ? sst.aws.v5.Dsql.get("MyCluster", { id: "kzttrvbdg4k2o5ze2m2rrwdj7u" })
+     *   : new sst.aws.v5.Dsql("MyCluster");
+     * ```
+     * #### Multi-region cluster
+     *
+     * ```ts title="sst.config.ts"
+     * const cluster = sst.aws.v5.Dsql.get("MyCluster", {
+     *   id: "app-dev-mycluster",
+     *   peer: {
+     *     id: "kzttrvbdg4k2o5ze2m2rrwdj7u",
+     *     region: "us-east-2",
+     *   }
+     * });
+     * ```
+     */
+    static get(name: string, args: {
+        id: Input<string>;
+        peer?: {
+            id: string;
+            region: string;
+        };
+    }, opts?: ComponentResourceOptions): Dsql;
+}
+export {};
+//# sourceMappingURL=dsql.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"dsql.d.ts","sourceRoot":"","sources":["../../../../../src/components/aws/v5/dsql.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,wBAAwB,EAEzB,MAAM,gBAAgB,CAAC;AAExB,OAAO,EACL,aAAa,EAId,MAAM,uBAAuB,CAAC;AAE/B,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEzC,OAAO,EAAE,KAAK,YAAY,EAAU,MAAM,gBAAgB,CAAC;AAQ3D,OAAO,EAAE,KAAK,MAAM,EAAS,MAAM,gBAAgB,CAAC;AAEpD,QAAA,MAAM,KAAK;IACT;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;;OAGG;;IAEH;;OAEG;;IAOH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;;OAGG;;IAEH;;OAEG;;IAEH;;OAEG;;CAEJ,CAAC;AAEF,MAAM,WAAW,QAAS,SAAQ,aAAa,CAAC,OAAO,KAAK,CAAC;IAC3D;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,OAAO,CAAC,EAAE;QACR,iEAAiE;QACjE,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QACvB,2CAA2C;QAC3C,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,MAAM,CAAC,EACH,OAAO,GACP;QACE;;;;;;;;;;;;;;;;WAgBG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QACzB;;;WAGG;QACH,SAAS,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;KACjC,CAAC;IAEN;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,GAAG,CAAC,EACA,MAAM,GACN;QACE,0CAA0C;QAC1C,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,CAAC,EAAE;YACV;;;;eAIG;YACH,UAAU,CAAC,EAAE,OAAO,CAAC;YACrB;;;;eAIG;YACH,UAAU,CAAC,EAAE,OAAO,CAAC;SACtB,CAAC;KACH,CAAC;CACP;;IAtMC;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;;OAGG;;IAEH;;OAEG;;IAOH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;;OAGG;;IAEH;;OAEG;;IAEH;;OAEG;;;AAmJL;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8GG;AACH,qBAAa,IAAK,SAAQ,SAAgC;gBAEtD,IAAI,EAAE,MAAM,EACZ,IAAI,GAAE,QAAa,EACnB,IAAI,CAAC,EAAE,wBAAwB;IAsMjC,iCAAiC;IACjC,IAAW,MAAM,4CAEhB;IAED,mCAAmC;IACnC,IAAW,QAAQ,4CASlB;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAW,IAAI;QAOX,sCAAsC;;QAEtC,wCAAwC;;MAG3C;IAED;;;OAGG;IACI,IAAI;;;;;gBAXP,sCAAsC;;gBAEtC,wCAAwC;;;;;;;;;;;;;;;;IA4B5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;WACW,GAAG,CACf,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE;QACJ,EAAE,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAClB,IAAI,CAAC,EAAE;YACL,EAAE,EAAE,MAAM,CAAC;YACX,MAAM,EAAE,MAAM,CAAC;SAChB,CAAC;KACH,EACD,IAAI,CAAC,EAAE,wBAAwB;CAclC"}