pulumi-aws-kotlin/com.pulumi.aws.appsync.kotlin/FunctionArgs

FunctionArgs

data class FunctionArgs(val apiId: Output<String>? = null, val code: Output<String>? = null, val dataSource: Output<String>? = null, val description: Output<String>? = null, val functionVersion: Output<String>? = null, val maxBatchSize: Output<Int>? = null, val name: Output<String>? = null, val requestMappingTemplate: Output<String>? = null, val responseMappingTemplate: Output<String>? = null, val runtime: Output<FunctionRuntimeArgs>? = null, val syncConfig: Output<FunctionSyncConfigArgs>? = null) : ConvertibleToJava<FunctionArgs>

Provides an AppSync Function.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.appsync.GraphQLApi;
import com.pulumi.aws.appsync.GraphQLApiArgs;
import com.pulumi.aws.appsync.DataSource;
import com.pulumi.aws.appsync.DataSourceArgs;
import com.pulumi.aws.appsync.inputs.DataSourceHttpConfigArgs;
import com.pulumi.aws.appsync.Function;
import com.pulumi.aws.appsync.FunctionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var exampleGraphQLApi = new GraphQLApi("exampleGraphQLApi", GraphQLApiArgs.builder()
            .authenticationType("API_KEY")
            .schema("""
type Mutation {
  putPost(id: ID!, title: String!): Post
}
type Post {
  id: ID!
  title: String!
}
type Query {
  singlePost(id: ID!): Post
}
schema {
  query: Query
  mutation: Mutation
}
            """)
            .build());
        var exampleDataSource = new DataSource("exampleDataSource", DataSourceArgs.builder()
            .apiId(exampleGraphQLApi.id())
            .name("example")
            .type("HTTP")
            .httpConfig(DataSourceHttpConfigArgs.builder()
                .endpoint("http://example.com")
                .build())
            .build());
        var exampleFunction = new Function("exampleFunction", FunctionArgs.builder()
            .apiId(exampleGraphQLApi.id())
            .dataSource(exampleDataSource.name())
            .name("example")
            .requestMappingTemplate("""
{
    "version": "2018-05-29",
    "method": "GET",
    "resourcePath": "/",
    "params":{
        "headers": $utils.http.copyheaders($ctx.request.headers)
    }
}
            """)
            .responseMappingTemplate("""
#if($ctx.result.statusCode == 200)
    $ctx.result.body
#else
    $utils.appendError($ctx.result.body, $ctx.result.statusCode)
#end
            """)
            .build());
    }
}

With Code

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.appsync.Function;
import com.pulumi.aws.appsync.FunctionArgs;
import com.pulumi.aws.appsync.inputs.FunctionRuntimeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var example = new Function("example", FunctionArgs.builder()
            .apiId(aws_appsync_graphql_api.example().id())
            .dataSource(aws_appsync_datasource.example().name())
            .name("example")
            .code(Files.readString(Paths.get("some-code-dir")))
            .runtime(FunctionRuntimeArgs.builder()
                .name("APPSYNC_JS")
                .runtimeVersion("1.0.0")
                .build())
            .build());
    }
}

Import

aws_appsync_function can be imported using the AppSync API ID and Function ID separated by -, e.g.,

$ pulumi import aws:appsync/function:Function example xxxxx-yyyyy

Constructors

FunctionArgs

constructor(apiId: Output<String>? = null, code: Output<String>? = null, dataSource: Output<String>? = null, description: Output<String>? = null, functionVersion: Output<String>? = null, maxBatchSize: Output<Int>? = null, name: Output<String>? = null, requestMappingTemplate: Output<String>? = null, responseMappingTemplate: Output<String>? = null, runtime: Output<FunctionRuntimeArgs>? = null, syncConfig: Output<FunctionSyncConfigArgs>? = null)

Properties

apiId

val apiId: Output<String>? = null

ID of the associated AppSync API.

code

val code: Output<String>? = null

The function code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.

dataSource

val dataSource: Output<String>? = null

Function data source name.

description

val description: Output<String>? = null

Function description.

functionVersion

val functionVersion: Output<String>? = null

Version of the request mapping template. Currently the supported value is 2018-05-29. Does not apply when specifying code.

maxBatchSize

val maxBatchSize: Output<Int>? = null

Maximum batching size for a resolver. Valid values are between 0 and 2000.

name

val name: Output<String>? = null

Function name. The function name does not have to be unique.

requestMappingTemplate

val requestMappingTemplate: Output<String>? = null

Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.

responseMappingTemplate

val responseMappingTemplate: Output<String>? = null

Function response mapping template.

runtime

val runtime: Output<FunctionRuntimeArgs>? = null

Describes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified. See Runtime.

syncConfig

val syncConfig: Output<FunctionSyncConfigArgs>? = null

Describes a Sync configuration for a resolver. See Sync Config.

Functions

toJava

open override fun toJava(): FunctionArgs