Package software.amazon.awscdk.services.appsync

Class AppsyncFunction

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.appsync.AppsyncFunction

All Implemented Interfaces:

IResource, IAppsyncFunction, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.110.0 (build 336b265)",
           date="2025-05-07T19:18:43.029Z")
@Stability(Stable)
public class AppsyncFunction
extends Resource
implements IAppsyncFunction

AppSync Functions are local functions that perform certain operations onto a backend data source.

Developers can compose operations (Functions) and execute them in sequence with Pipeline Resolvers.

Example:

 GraphqlApi api;
 AppsyncFunction appsyncFunction = AppsyncFunction.Builder.create(this, "function")
         .name("appsync_function")
         .api(api)
         .dataSource(api.addNoneDataSource("none"))
         .requestMappingTemplate(MappingTemplate.fromFile("request.vtl"))
         .responseMappingTemplate(MappingTemplate.fromFile("response.vtl"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AppsyncFunction.Builder	A fluent builder for AppsyncFunction.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.appsync.IAppsyncFunction

IAppsyncFunction.Jsii$Default, IAppsyncFunction.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AppsyncFunction(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	AppsyncFunction(software.amazon.jsii.JsiiObjectRef objRef)
	AppsyncFunction(software.constructs.Construct scope, String id, AppsyncFunctionProps props)

Method Summary

Modifier and Type	Method	Description
static IAppsyncFunction	fromAppsyncFunctionAttributes(software.constructs.Construct scope, String id, AppsyncFunctionAttributes attrs)	Import Appsync Function from arn.
BaseDataSource	getDataSource()	the data source of this AppSync Function.
String	getFunctionArn()	the ARN of the AppSync function.
String	getFunctionId()	the ID of the AppSync function.
String	getFunctionName()	the name of this AppSync Function.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

AppsyncFunction

protected AppsyncFunction(software.amazon.jsii.JsiiObjectRef objRef)

AppsyncFunction

protected AppsyncFunction(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

AppsyncFunction

@Stability(Stable)
public AppsyncFunction(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 AppsyncFunctionProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromAppsyncFunctionAttributes

@Stability(Stable)
@NotNull
public static IAppsyncFunction fromAppsyncFunctionAttributes(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 AppsyncFunctionAttributes attrs)

Import Appsync Function from arn.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

getDataSource

@Stability(Stable)
@NotNull
public BaseDataSource getDataSource()

the data source of this AppSync Function.

getFunctionArn

@Stability(Stable)
@NotNull
public String getFunctionArn()

the ARN of the AppSync function.

Specified by:

getFunctionArn in interface IAppsyncFunction

getFunctionId

@Stability(Stable)
@NotNull
public String getFunctionId()

the ID of the AppSync function.

Specified by:

getFunctionId in interface IAppsyncFunction

getFunctionName

@Stability(Stable)
@NotNull
public String getFunctionName()

the name of this AppSync Function.