software.amazon.awscdk.services.appsync

Class AppsyncFunction

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.appsync.AppsyncFunction

All Implemented Interfaces:

IConstruct, IDependable, IResource, IAppsyncFunction

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:30.661Z")
public class AppsyncFunction
extends Resource
implements IAppsyncFunction

(experimental) 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 and Description
static class	AppsyncFunction.Builder (experimental) A fluent builder for AppsyncFunction.

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

IAppsyncFunction.Jsii$Default, IAppsyncFunction.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class software.amazon.awscdk.core.Resource

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

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

AppsyncFunction

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

AppsyncFunction

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

AppsyncFunction

public AppsyncFunction(software.constructs.Construct scope,
                       java.lang.String id,
                       AppsyncFunctionProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromAppsyncFunctionAttributes

public static IAppsyncFunction fromAppsyncFunctionAttributes(software.constructs.Construct scope,
                                                             java.lang.String id,
                                                             AppsyncFunctionAttributes attrs)

(experimental) Import Appsync Function from arn.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

getDataSource

public BaseDataSource getDataSource()

(experimental) the data source of this AppSync Function.

getFunctionArn

public java.lang.String getFunctionArn()

(experimental) the ARN of the AppSync function.

Specified by:

getFunctionArn in interface IAppsyncFunction

getFunctionId

public java.lang.String getFunctionId()

(experimental) the ID of the AppSync function.

Specified by:

getFunctionId in interface IAppsyncFunction

getFunctionName

public java.lang.String getFunctionName()

(experimental) the name of this AppSync Function.