AppsyncFunction

class aws_cdk.aws_appsync.AppsyncFunction(scope, id, *, api, data_source, name, code=None, description=None, request_mapping_template=None, response_mapping_template=None, runtime=None)

Bases: Resource

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.

Resource:

AWS::AppSync::FunctionConfiguration

ExampleMetadata:

infused

Example:

# api: appsync.GraphqlApi


appsync_function = appsync.AppsyncFunction(self, "function",
    name="appsync_function",
    api=api,
    data_source=api.add_none_data_source("none"),
    request_mapping_template=appsync.MappingTemplate.from_file("request.vtl"),
    response_mapping_template=appsync.MappingTemplate.from_file("response.vtl")
)
Parameters:
  • scope (Construct) –

  • id (str) –

  • api (IGraphqlApi) – the GraphQL Api linked to this AppSync Function.

  • data_source (BaseDataSource) – the data source linked to this AppSync Function.

  • name (str) – the name of the AppSync Function.

  • code (Optional[Code]) – The function code. Default: - no code is used

  • description (Optional[str]) – the description for this AppSync Function. Default: - no description

  • request_mapping_template (Optional[MappingTemplate]) – the request mapping template for the AppSync Function. Default: - no request mapping template

  • response_mapping_template (Optional[MappingTemplate]) – the response mapping template for the AppSync Function. Default: - no response mapping template

  • runtime (Optional[FunctionRuntime]) – The functions runtime. Default: - no function runtime, VTL mapping templates used

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (RemovalPolicy) –

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Attributes

data_source

the data source of this AppSync Function.

Attribute:

DataSourceName

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

function_arn

the ARN of the AppSync function.

Attribute:

true

function_id

the ID of the AppSync function.

Attribute:

true

function_name

the name of this AppSync Function.

Attribute:

Name

node

The tree node.

stack

The stack in which this resource is defined.

Static Methods

classmethod from_appsync_function_attributes(scope, id, *, function_arn)

Import Appsync Function from arn.

Parameters:
  • scope (Construct) –

  • id (str) –

  • function_arn (str) – the ARN of the AppSync function.

Return type:

IAppsyncFunction

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool