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

package/platform/types/components/aws/v5/app-sync.d.ts

@@ -0,0 +1,424 @@
+import { ComponentResourceOptions } from "@pulumi/pulumi";
+import { V5Args } from "../../parts-component";
+import type { Input } from "../../input";
+import { DnsValidatedCertificate } from "../dns-validated-certificate";
+import { Function } from "./function";
+import { CustomDomainArgs } from "../helpers/custom-domain";
+import type { AppSyncArgs as OriginalAppSyncArgs, AppSyncDataSourceArgs as OriginalAppSyncDataSourceArgs, AppSyncFunctionArgs as OriginalAppSyncFunctionArgs, AppSyncResolverArgs as OriginalAppSyncResolverArgs } from "../app-sync";
+declare const parts: () => {
+    /**
+     * The Amazon AppSync GraphQL API.
+     */
+    api: typeof import("@pulumi/aws/appsync/graphQLApi").GraphQLApi;
+    /**
+     * The certificate for the custom domain, created when `domain` is set
+     * without a `cert`.
+     */
+    certificate: import("../..").OptionalPart<typeof DnsValidatedCertificate>;
+    /**
+     * The AppSync custom domain name, when `domain` is set.
+     */
+    domainName: import("../..").OptionalPart<typeof import("@pulumi/aws/appsync/domainName").DomainName>;
+    /**
+     * The association between the custom domain name and the API.
+     */
+    domainAssociation: import("../..").OptionalPart<typeof import("@pulumi/aws/appsync/domainNameApiAssociation").DomainNameApiAssociation>;
+    /**
+     * The API's data sources, by data source name.
+     */
+    dataSource: import("../..").ManyPart<typeof import("@pulumi/aws/appsync/dataSource").DataSource>;
+    /**
+     * The function behind each Lambda data source, by data source name.
+     */
+    dataSourceFunction: import("../..").ManyPart<import("../..").DeferredPart<typeof Function>>;
+    /**
+     * The IAM role AppSync assumes to reach each data source, by data source
+     * name. HTTP, RDS and empty data sources don't have one.
+     */
+    serviceRole: import("../..").ManyPart<typeof import("@pulumi/aws/iam/role").Role>;
+    /**
+     * The API's AppSync functions, by function name.
+     */
+    function: import("../..").ManyPart<typeof import("@pulumi/aws/appsync/function").Function>;
+    /**
+     * The API's resolvers, by operation, like `Query user`.
+     */
+    resolver: import("../..").ManyPart<typeof import("@pulumi/aws/appsync/resolver").Resolver>;
+};
+export interface AppSyncDomainArgs extends CustomDomainArgs {
+    /**
+     * The ARN of an ACM (AWS Certificate Manager) certificate that proves ownership of the
+     * domain. By default, a certificate is created and validated automatically.
+     *
+     * AppSync takes its certificate from the `us-east-1` region. The one that's created for
+     * you is created there, and one you pass in has to be there too.
+     *
+     * :::tip
+     * You need to pass in a `cert` for domains that are not hosted on supported `dns` providers.
+     * :::
+     */
+    cert?: Input<string>;
+}
+export interface AppSyncArgs extends V5Args<Omit<OriginalAppSyncArgs, "domain">, typeof parts> {
+    /**
+     * Set a custom domain for your AppSync GraphQL API.
+     *
+     * Automatically manages domains hosted on AWS Route 53, Cloudflare, and
+     * Vercel. For other providers, pass in a `cert` that validates domain
+     * ownership and add the DNS records yourself.
+     *
+     * @example
+     *
+     * By default this assumes the domain is hosted on Route 53.
+     *
+     * ```js
+     * {
+     *   domain: "example.com"
+     * }
+     * ```
+     *
+     * For domains hosted on Cloudflare.
+     *
+     * ```js
+     * {
+     *   domain: {
+     *     name: "example.com",
+     *     dns: sst.cloudflare.dns()
+     *   }
+     * }
+     * ```
+     */
+    domain?: string | AppSyncDomainArgs;
+}
+export interface AppSyncDataSourceArgs extends Omit<OriginalAppSyncDataSourceArgs, "transform"> {
+}
+export interface AppSyncFunctionArgs extends Omit<OriginalAppSyncFunctionArgs, "transform"> {
+}
+export interface AppSyncResolverArgs extends Omit<OriginalAppSyncResolverArgs, "transform"> {
+}
+declare const AppSync_base: import("../..").ComponentClass<{
+    /**
+     * The Amazon AppSync GraphQL API.
+     */
+    api: typeof import("@pulumi/aws/appsync/graphQLApi").GraphQLApi;
+    /**
+     * The certificate for the custom domain, created when `domain` is set
+     * without a `cert`.
+     */
+    certificate: import("../..").OptionalPart<typeof DnsValidatedCertificate>;
+    /**
+     * The AppSync custom domain name, when `domain` is set.
+     */
+    domainName: import("../..").OptionalPart<typeof import("@pulumi/aws/appsync/domainName").DomainName>;
+    /**
+     * The association between the custom domain name and the API.
+     */
+    domainAssociation: import("../..").OptionalPart<typeof import("@pulumi/aws/appsync/domainNameApiAssociation").DomainNameApiAssociation>;
+    /**
+     * The API's data sources, by data source name.
+     */
+    dataSource: import("../..").ManyPart<typeof import("@pulumi/aws/appsync/dataSource").DataSource>;
+    /**
+     * The function behind each Lambda data source, by data source name.
+     */
+    dataSourceFunction: import("../..").ManyPart<import("../..").DeferredPart<typeof Function>>;
+    /**
+     * The IAM role AppSync assumes to reach each data source, by data source
+     * name. HTTP, RDS and empty data sources don't have one.
+     */
+    serviceRole: import("../..").ManyPart<typeof import("@pulumi/aws/iam/role").Role>;
+    /**
+     * The API's AppSync functions, by function name.
+     */
+    function: import("../..").ManyPart<typeof import("@pulumi/aws/appsync/function").Function>;
+    /**
+     * The API's resolvers, by operation, like `Query user`.
+     */
+    resolver: import("../..").ManyPart<typeof import("@pulumi/aws/appsync/resolver").Resolver>;
+}>;
+/**
+ * The `AppSync` component lets you add an [Amazon AppSync GraphQL API](https://docs.aws.amazon.com/appsync/latest/devguide/what-is-appsync.html) to your app.
+ *
+ * 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. That includes the resources of each
+ * data source, function and resolver.
+ *
+ * @example
+ *
+ * #### Create a GraphQL API
+ *
+ * ```ts title="sst.config.ts"
+ * const api = new sst.aws.v5.AppSync("MyApi", {
+ *   schema: "schema.graphql"
+ * });
+ * ```
+ *
+ * #### Add a data source
+ *
+ * ```ts title="sst.config.ts"
+ * const lambdaDS = api.addDataSource({
+ *   name: "lambdaDS",
+ *   lambda: "src/lambda.handler"
+ * });
+ * ```
+ *
+ * #### Add a resolver
+ *
+ * ```ts title="sst.config.ts"
+ * api.addResolver("Query user", {
+ *   dataSource: lambdaDS.name
+ * });
+ * ```
+ *
+ * #### Add a pipeline resolver
+ *
+ * ```ts title="sst.config.ts"
+ * api.addFunction({
+ *   name: "getUser",
+ *   dataSource: "lambdaDS"
+ * });
+ * api.addResolver("Query user", {
+ *   kind: "pipeline",
+ *   functions: ["getUser"],
+ *   code: `
+ *     export function request(ctx) { return {}; }
+ *     export function response(ctx) { return ctx.prev.result; }
+ *   `
+ * });
+ * ```
+ *
+ * #### Add a custom domain
+ *
+ * ```js {3} title="sst.config.ts"
+ * new sst.aws.v5.AppSync("MyApi", {
+ *   schema: "schema.graphql",
+ *   domain: "api.example.com"
+ * });
+ * ```
+ *
+ * #### Default props for all data sources
+ *
+ * Use the `transform` to change every data source, its function or its role. An object is
+ * merged into each one.
+ *
+ * ```ts title="sst.config.ts" {4}
+ * const api = new sst.aws.v5.AppSync("MyApi", {
+ *   schema: "schema.graphql",
+ *   transform: {
+ *     dataSourceFunction: { memory: "2048 MB" }
+ *   }
+ * });
+ * ```
+ *
+ * A function is also given the data source's name, so it can change one of them. The same
+ * goes for `function`, by function name, and `resolver`, by operation.
+ *
+ * ```ts title="sst.config.ts"
+ * const api = new sst.aws.v5.AppSync("MyApi", {
+ *   schema: "schema.graphql",
+ *   transform: {
+ *     dataSourceFunction: (args, opts, name, dataSource) => {
+ *       if (dataSource === "lambdaDS") args.timeout = "60 seconds";
+ *     }
+ *   }
+ * });
+ * ```
+ *
+ * #### Switch from `sst.aws.AppSync`
+ *
+ * Change `sst.aws.AppSync` to `sst.aws.v5.AppSync` and keep the name. The API, its data
+ * sources, their roles and functions, its AppSync functions, its resolvers and its custom
+ * domain are kept. A few things are written differently:
+ *
+ * - `addDataSource` returns the AppSync data source and `addFunction` the AppSync function,
+ *   so `lambdaDS.name` reads the same. Their other resources are in the API's `nodes`, by
+ *   name: `lambdaDS.nodes.function` becomes `api.nodes.dataSourceFunction.lambdaDS`.
+ * - The `transform` of a data source, function or resolver becomes the API's `transform`
+ *   for `dataSource`, `serviceRole`, `dataSourceFunction`, `function` and `resolver`.
+ * - `domain` and `domain.dns` have to be plain values, not outputs.
+ * - A function created for a Lambda data source, and the association of a custom domain
+ *   with the API, are created with the API's `provider`. `sst.aws.AppSync` created both
+ *   with your app's provider, whatever the API was given. If your API has a `provider` and
+ *   either of these, they're replaced on switch: remove the data source or the domain and
+ *   deploy before you switch, then add it back.
+ *
+ * ```ts title="sst.config.ts" del={1} ins={2}
+ * const api = new sst.aws.AppSync("MyApi", { schema: "schema.graphql" });
+ * const api = new sst.aws.v5.AppSync("MyApi", { schema: "schema.graphql" });
+ * ```
+ */
+export declare class AppSync extends AppSync_base {
+    constructor(name: string, args: AppSyncArgs, opts?: ComponentResourceOptions);
+    private createDomainName;
+    /**
+     * The GraphQL API ID.
+     */
+    get id(): import("@pulumi/pulumi").Output<string>;
+    /**
+     * The URL of the GraphQL API.
+     *
+     * If the `domain` is set, this is the URL with the custom domain.
+     * Otherwise, it's the auto-generated AppSync URL.
+     */
+    get url(): import("@pulumi/pulumi").Output<string>;
+    /**
+     * Add a data source to this AppSync API.
+     *
+     * Returns the AppSync data source. Its `name` is what a resolver or a
+     * function takes as its `dataSource`.
+     *
+     * @param args Configure the data source.
+     *
+     * @example
+     *
+     * Add a Lambda function as a data source.
+     *
+     * ```js title="sst.config.ts"
+     * api.addDataSource({
+     *   name: "lambdaDS",
+     *   lambda: "src/lambda.handler"
+     * });
+     * ```
+     *
+     * Customize the Lambda function.
+     *
+     * ```js title="sst.config.ts"
+     * api.addDataSource({
+     *   name: "lambdaDS",
+     *   lambda: {
+     *     handler: "src/lambda.handler",
+     *     timeout: "60 seconds"
+     *   }
+     * });
+     * ```
+     *
+     * Add a data source with an existing Lambda function.
+     *
+     * ```js title="sst.config.ts"
+     * api.addDataSource({
+     *   name: "lambdaDS",
+     *   lambda: "arn:aws:lambda:us-east-1:123456789012:function:my-function"
+     * });
+     * ```
+     *
+     * Add a DynamoDB table as a data source.
+     *
+     * ```js title="sst.config.ts"
+     * api.addDataSource({
+     *   name: "dynamoDS",
+     *   dynamodb: "arn:aws:dynamodb:us-east-1:123456789012:table/my-table"
+     * });
+     * ```
+     *
+     * The data source's resources are in the API's `nodes`, by name.
+     *
+     * ```js title="sst.config.ts"
+     * api.nodes.dataSourceFunction.lambdaDS;
+     * api.nodes.serviceRole.dynamoDS;
+     * ```
+     */
+    addDataSource(args: AppSyncDataSourceArgs): import("@pulumi/aws/appsync/dataSource").DataSource;
+    /**
+     * Add a function to this AppSync API, for use in pipeline resolvers.
+     *
+     * Returns the AppSync function.
+     *
+     * @param args Configure the function.
+     *
+     * @example
+     *
+     * Add a function using a Lambda data source.
+     *
+     * ```js title="sst.config.ts"
+     * api.addFunction({
+     *   name: "myFunction",
+     *   dataSource: "lambdaDS"
+     * });
+     * ```
+     *
+     * Add a function using a DynamoDB data source.
+     *
+     * ```js title="sst.config.ts"
+     * api.addFunction({
+     *   name: "myFunction",
+     *   dataSource: "dynamoDS",
+     *   requestMappingTemplate: `{
+     *     "version": "2018-05-29",
+     *     "operation": "Scan"
+     *   }`,
+     *   responseMappingTemplate: `{
+     *     "users": $utils.toJson($context.result.items)
+     *   }`
+     * });
+     * ```
+     */
+    addFunction(args: AppSyncFunctionArgs): import("@pulumi/aws/appsync/function").Function;
+    /**
+     * Add a resolver to this AppSync API.
+     *
+     * @param operation The type and name of the operation.
+     * @param args Configure the resolver.
+     *
+     * @example
+     *
+     * Add a resolver using a Lambda data source.
+     *
+     * ```js title="sst.config.ts"
+     * api.addResolver("Query user", {
+     *   dataSource: "lambdaDS"
+     * });
+     * ```
+     *
+     * Add a resolver using a DynamoDB data source.
+     *
+     * ```js title="sst.config.ts"
+     * api.addResolver("Query user", {
+     *   dataSource: "dynamoDS",
+     *   requestTemplate: `{
+     *     "version": "2017-02-28",
+     *     "operation": "Scan"
+     *   }`,
+     *   responseTemplate: `{
+     *     "users": $utils.toJson($context.result.items)
+     *   }`
+     * });
+     * ```
+     *
+     * Add a pipeline resolver. Its `functions` are the names of functions added
+     * with `addFunction`, or the ids of AppSync functions.
+     *
+     * ```js title="sst.config.ts"
+     * api.addResolver("Query user", {
+     *   kind: "pipeline",
+     *   functions: ["myFunction1", "myFunction2"],
+     *   code: `
+     *     export function request(ctx) {
+     *       return {};
+     *     }
+     *     export function response(ctx) {
+     *       return ctx.result;
+     *     }
+     *   `
+     * });
+     * ```
+     *
+     * The resolver is in the API's `nodes`, by operation.
+     *
+     * ```js title="sst.config.ts"
+     * api.nodes.resolver["Query user"];
+     * ```
+     */
+    addResolver(operation: string, args?: AppSyncResolverArgs): this;
+    private dataSourceName;
+    private functionIds;
+    /**
+     * Linking an API gives the linked resource its URL.
+     */
+    link(): {
+        properties: {
+            url: import("@pulumi/pulumi").Output<string>;
+        };
+    };
+}
+export {};
+//# sourceMappingURL=app-sync.d.ts.map

package/platform/types/components/aws/v5/app-sync.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-sync.d.ts","sourceRoot":"","sources":["../../../../../src/components/aws/v5/app-sync.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,wBAAwB,EAAuB,MAAM,gBAAgB,CAAC;AAE/E,OAAO,EACL,MAAM,EAKP,MAAM,uBAAuB,CAAC;AAE/B,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEzC,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,EAAE,gBAAgB,EAAgB,MAAM,0BAA0B,CAAC;AAG1E,OAAO,KAAK,EACV,WAAW,IAAI,mBAAmB,EAClC,qBAAqB,IAAI,6BAA6B,EACtD,mBAAmB,IAAI,2BAA2B,EAClD,mBAAmB,IAAI,2BAA2B,EACnD,MAAM,aAAa,CAAC;AAErB,QAAA,MAAM,KAAK;IACT;;OAEG;;IAEH;;;OAGG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;;OAGG;;IAEH;;OAEG;;IAEH;;OAEG;;CAEH,CAAC;AAEH,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD;;;;;;;;;;OAUG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,MAAM,WAAW,WACf,SAAQ,MAAM,CAAC,IAAI,CAAC,mBAAmB,EAAE,QAAQ,CAAC,EAAE,OAAO,KAAK,CAAC;IACjE;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAAC;CACrC;AAED,MAAM,WAAW,qBACf,SAAQ,IAAI,CAAC,6BAA6B,EAAE,WAAW,CAAC;CAAG;AAE7D,MAAM,WAAW,mBACf,SAAQ,IAAI,CAAC,2BAA2B,EAAE,WAAW,CAAC;CAAG;AAE3D,MAAM,WAAW,mBACf,SAAQ,IAAI,CAAC,2BAA2B,EAAE,WAAW,CAAC;CAAG;;IA/FzD;;OAEG;;IAEH;;;OAGG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;;OAGG;;IAEH;;OAEG;;IAEH;;OAEG;;;AA6DL;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8GG;AACH,qBAAa,OAAQ,SAAQ,YAAmC;gBAE5D,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,WAAW,EACjB,IAAI,CAAC,EAAE,wBAAwB;IA+BjC,OAAO,CAAC,gBAAgB;IA6BxB;;OAEG;IACH,IAAW,EAAE,4CAEZ;IAED;;;;;OAKG;IACH,IAAW,GAAG,4CAKb;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACI,aAAa,CAAC,IAAI,EAAE,qBAAqB;IAoDhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACI,WAAW,CAAC,IAAI,EAAE,mBAAmB;IAe5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsDG;IACI,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,GAAE,mBAAwB;IAuCpE,OAAO,CAAC,cAAc;IAStB,OAAO,CAAC,WAAW;IAQnB;;OAEG;IACI,IAAI;;;;;CAKZ"}