sst 3.4.24 → 3.4.25

package/dist/aws/task.d.ts

@@ -0,0 +1,154 @@
+import { AwsOptions } from "./client.js";
+/**
+ * The `task` client SDK is available through the following.
+ *
+ * @example
+ * ```js title="src/app.ts"
+ * import { task } from "sst/aws/task";
+ * ```
+ */
+export declare namespace task {
+    /**
+     * The link data for the task.
+     *
+     * @example
+     * For example, let's say you have a task.
+     *
+     * ```js title="sst.config.ts"
+     * cluster.addTask("MyTask");
+     * ```
+     *
+     * `Resource.MyTask` will have all the link data.
+     *
+     * ```js title="src/app.ts"
+     * import { Resource } from "sst";
+     *
+     * console.log(Resource.MyTask);
+     * ```
+     */
+    interface Resource {
+        /**
+         * The ARN of the cluster.
+         */
+        cluster: string;
+        /**
+         * The ARN of the task definition.
+         */
+        taskDefinition: string;
+        /**
+         * The subnets to use for the task.
+         */
+        subnets: string[];
+        /**
+         * The security groups to use for the task.
+         */
+        securityGroups: string[];
+        /**
+         * Whether to assign a public IP address to the task.
+         */
+        assignPublicIp: boolean;
+        /**
+         * The names of the containers in the task.
+         */
+        containers: string[];
+    }
+    interface Options {
+        /**
+         * Configure the AWS client.
+         */
+        aws?: AwsOptions;
+    }
+    /**
+     * Gets the details of a task. Tasks stopped longer than 1 hour are not returned.
+     *
+     * @example
+     * For example, let's say you have started task.
+     *
+     * ```js title="src/app.ts"
+     * import { Resource } from "sst";
+     * import { task } from "sst/aws/task";
+     *
+     * const runRet = await task.run(Resource.MyTask);
+     * const taskArn = runRet.tasks[0].taskArn;
+     * ```
+     *
+     * You can get the details of the task with the following.
+     *
+     * ```js title="src/app.ts"
+     * const describeRet = await task.describe(Resource.MyTask, taskArn);
+     * ```
+     */
+    function describe(resource: Resource, task: string, options?: Options): Promise<any>;
+    /**
+     * Runs a task.
+     *
+     * @example
+     *
+     * For example, let's say you have a task.
+     *
+     * ```js title="sst.config.ts"
+     * cluster.addTask("MyTask");
+     * ```
+     *
+     * You can run it in your application with the following.
+     *
+     * ```js title="src/app.ts"
+     * import { Resource } from "sst";
+     * import { task } from "sst/aws/task";
+     *
+     * const runRet = await task.run(Resource.MyTask);
+     * const taskArn = runRet.tasks[0].taskArn;
+     * ```
+     *
+     * `taskArn` is the ARN of the task. You can pass it to the `describe` function to get
+     * the status of the task; or to the `stop` function to stop the task.
+     *
+     * You can also pass in environment variables to the task.
+     *
+     * ```js title="src/app.ts"
+     * await task.run(Resource.MyTask, {
+     *   MY_ENV_VAR: "my-value",
+     * });
+     * ```
+     */
+    function run(resource: Resource, environment?: Record<string, string>, options?: {
+        aws?: AwsOptions;
+    }): Promise<any>;
+    /**
+     * Stops a task.
+     *
+     * @example
+     *
+     * For example, let's say you have started a task.
+     *
+     * ```js title="src/app.ts"
+     * import { Resource } from "sst";
+     * import { task } from "sst/aws/task";
+     *
+     * const runRet = await task.run(Resource.MyTask);
+     * const taskArn = runRet.tasks[0].taskArn;
+     * ```
+     *
+     * You can stop the task with the following.
+     *
+     * ```js title="src/app.ts"
+     * const stopRet = await task.stop(Resource.MyTask, taskArn);
+     *
+     * // check if the task is stopped
+     * console.log(stopRet.task?.lastStatus);
+     * ```
+     */
+    function stop(resource: Resource, task: string, options?: Options): Promise<any>;
+    class DescribeError extends Error {
+        readonly response: Response;
+        constructor(response: Response);
+    }
+    class RunError extends Error {
+        readonly response: Response;
+        constructor(response: Response);
+    }
+    class StopError extends Error {
+        readonly response: Response;
+        constructor(response: Response);
+    }
+}

package/dist/aws/task.js

@@ -0,0 +1,197 @@
+import { client } from "./client.js";
+/**
+ * The `task` client SDK is available through the following.
+ *
+ * @example
+ * ```js title="src/app.ts"
+ * import { task } from "sst/aws/task";
+ * ```
+ */
+export var task;
+(function (task_1) {
+    function url(region, options) {
+        if (options?.region)
+            region = options.region;
+        return `https://ecs.${region}.amazonaws.com/`;
+    }
+    /**
+     * Gets the details of a task. Tasks stopped longer than 1 hour are not returned.
+     *
+     * @example
+     * For example, let's say you have started task.
+     *
+     * ```js title="src/app.ts"
+     * import { Resource } from "sst";
+     * import { task } from "sst/aws/task";
+     *
+     * const runRet = await task.run(Resource.MyTask);
+     * const taskArn = runRet.tasks[0].taskArn;
+     * ```
+     *
+     * You can get the details of the task with the following.
+     *
+     * ```js title="src/app.ts"
+     * const describeRet = await task.describe(Resource.MyTask, taskArn);
+     * ```
+     */
+    async function describe(resource, task, options) {
+        const c = await client();
+        const u = url(c.region, options?.aws);
+        const res = await c.fetch(u, {
+            method: "POST",
+            aws: options?.aws,
+            headers: {
+                "X-Amz-Target": "AmazonEC2ContainerServiceV20141113.DescribeTasks",
+                "Content-Type": "application/x-amz-json-1.1",
+            },
+            body: JSON.stringify({
+                cluster: resource.cluster,
+                tasks: [task],
+            }),
+        });
+        if (!res.ok)
+            throw new DescribeError(res);
+        return res.json();
+    }
+    task_1.describe = describe;
+    /**
+     * Runs a task.
+     *
+     * @example
+     *
+     * For example, let's say you have a task.
+     *
+     * ```js title="sst.config.ts"
+     * cluster.addTask("MyTask");
+     * ```
+     *
+     * You can run it in your application with the following.
+     *
+     * ```js title="src/app.ts"
+     * import { Resource } from "sst";
+     * import { task } from "sst/aws/task";
+     *
+     * const runRet = await task.run(Resource.MyTask);
+     * const taskArn = runRet.tasks[0].taskArn;
+     * ```
+     *
+     * `taskArn` is the ARN of the task. You can pass it to the `describe` function to get
+     * the status of the task; or to the `stop` function to stop the task.
+     *
+     * You can also pass in environment variables to the task.
+     *
+     * ```js title="src/app.ts"
+     * await task.run(Resource.MyTask, {
+     *   MY_ENV_VAR: "my-value",
+     * });
+     * ```
+     */
+    async function run(resource, environment, options) {
+        const c = await client();
+        const u = url(c.region, options?.aws);
+        const res = await c.fetch(u, {
+            method: "POST",
+            aws: options?.aws,
+            headers: {
+                "X-Amz-Target": "AmazonEC2ContainerServiceV20141113.RunTask",
+                "Content-Type": "application/x-amz-json-1.1",
+            },
+            body: JSON.stringify({
+                cluster: resource.cluster,
+                launchType: "FARGATE",
+                taskDefinition: resource.taskDefinition,
+                networkConfiguration: {
+                    awsvpcConfiguration: {
+                        subnets: resource.subnets,
+                        securityGroups: resource.securityGroups,
+                        assignPublicIp: resource.assignPublicIp ? "ENABLED" : "DISABLED",
+                    },
+                },
+                overrides: {
+                    containerOverrides: resource.containers.map((name) => ({
+                        name,
+                        environment: Object.entries(environment ?? {}).map(([key, value]) => ({
+                            name: key,
+                            value,
+                        })),
+                    })),
+                },
+            }),
+        });
+        if (!res.ok)
+            throw new RunError(res);
+        return res.json();
+    }
+    task_1.run = run;
+    /**
+     * Stops a task.
+     *
+     * @example
+     *
+     * For example, let's say you have started a task.
+     *
+     * ```js title="src/app.ts"
+     * import { Resource } from "sst";
+     * import { task } from "sst/aws/task";
+     *
+     * const runRet = await task.run(Resource.MyTask);
+     * const taskArn = runRet.tasks[0].taskArn;
+     * ```
+     *
+     * You can stop the task with the following.
+     *
+     * ```js title="src/app.ts"
+     * const stopRet = await task.stop(Resource.MyTask, taskArn);
+     *
+     * // check if the task is stopped
+     * console.log(stopRet.task?.lastStatus);
+     * ```
+     */
+    async function stop(resource, task, options) {
+        const c = await client();
+        const u = url(c.region, options?.aws);
+        const res = await c.fetch(u, {
+            method: "POST",
+            aws: options?.aws,
+            headers: {
+                "X-Amz-Target": "AmazonEC2ContainerServiceV20141113.StopTask",
+                "Content-Type": "application/x-amz-json-1.1",
+            },
+            body: JSON.stringify({
+                cluster: resource.cluster,
+                task,
+            }),
+        });
+        if (!res.ok)
+            throw new StopError(res);
+        return res.json();
+    }
+    task_1.stop = stop;
+    class DescribeError extends Error {
+        response;
+        constructor(response) {
+            super("Failed to describe task");
+            this.response = response;
+            console.log(response);
+        }
+    }
+    task_1.DescribeError = DescribeError;
+    class RunError extends Error {
+        response;
+        constructor(response) {
+            super("Failed to run task");
+            this.response = response;
+            console.log(response);
+        }
+    }
+    task_1.RunError = RunError;
+    class StopError extends Error {
+        response;
+        constructor(response) {
+            super("Failed to stop task");
+            this.response = response;
+            console.log(response);
+        }
+    }
+    task_1.StopError = StopError;
+})(task || (task = {}));