aws-cdk-lib.aws_appsync.CfnFunctionConfiguration

class CfnFunctionConfiguration (construct)

LanguageType name
.NETAmazon.CDK.AWS.AppSync.CfnFunctionConfiguration
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappsync#CfnFunctionConfiguration
Javasoftware.amazon.awscdk.services.appsync.CfnFunctionConfiguration
Pythonaws_cdk.aws_appsync.CfnFunctionConfiguration
TypeScript aws-cdk-lib » aws_appsync » CfnFunctionConfiguration

Implements IConstruct, IDependable, IInspectable

A CloudFormation AWS::AppSync::FunctionConfiguration.

The AWS::AppSync::FunctionConfiguration resource defines the functions in GraphQL APIs to perform certain operations. You can use pipeline resolvers to attach functions. For more information, see Pipeline Resolvers in the AWS AppSync Developer Guide .

When you submit an update, AWS CloudFormation updates resources based on differences between what you submit and the stack's current template. To cause this resource to be updated you must change a property value for this resource in the AWS CloudFormation template. Changing the Amazon S3 file content without changing a property value will not result in an update operation.

See Update Behaviors of Stack Resources in the AWS CloudFormation User Guide .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appsync as appsync } from 'aws-cdk-lib';
const cfnFunctionConfiguration = new appsync.CfnFunctionConfiguration(this, 'MyCfnFunctionConfiguration', {
  apiId: 'apiId',
  dataSourceName: 'dataSourceName',
  name: 'name',

  // the properties below are optional
  code: 'code',
  codeS3Location: 'codeS3Location',
  description: 'description',
  functionVersion: 'functionVersion',
  maxBatchSize: 123,
  requestMappingTemplate: 'requestMappingTemplate',
  requestMappingTemplateS3Location: 'requestMappingTemplateS3Location',
  responseMappingTemplate: 'responseMappingTemplate',
  responseMappingTemplateS3Location: 'responseMappingTemplateS3Location',
  runtime: {
    name: 'name',
    runtimeVersion: 'runtimeVersion',
  },
  syncConfig: {
    conflictDetection: 'conflictDetection',

    // the properties below are optional
    conflictHandler: 'conflictHandler',
    lambdaConflictHandlerConfig: {
      lambdaConflictHandlerArn: 'lambdaConflictHandlerArn',
    },
  },
});

Initializer

new CfnFunctionConfiguration(scope: Construct, id: string, props: CfnFunctionConfigurationProps)

Parameters

  • scope Construct — - scope in which this resource is defined.
  • id string — - scoped id of the resource.
  • props CfnFunctionConfigurationProps — - resource properties.

Create a new AWS::AppSync::FunctionConfiguration.

Construct Props

NameTypeDescription
apiIdstringThe AWS AppSync GraphQL API that you want to attach using this function.
dataSourceNamestringThe name of data source this function will attach.
namestringThe name of the function.
code?stringThe resolver code that contains the request and response functions.
codeS3Location?stringThe Amazon S3 endpoint.
description?stringThe Function description.
functionVersion?stringThe version of the request mapping template.
maxBatchSize?numberThe maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation.
requestMappingTemplate?stringThe Function request mapping template.
requestMappingTemplateS3Location?stringDescribes a Sync configuration for a resolver.
responseMappingTemplate?stringThe Function response mapping template.
responseMappingTemplateS3Location?stringThe location of a response mapping template in an Amazon S3 bucket.
runtime?IResolvable | AppSyncRuntimePropertyDescribes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function.
syncConfig?IResolvable | SyncConfigPropertyDescribes a Sync configuration for a resolver.

apiId

Type: string

The AWS AppSync GraphQL API that you want to attach using this function.


dataSourceName

Type: string

The name of data source this function will attach.


name

Type: string

The name of the function.


code?

Type: string (optional)

The resolver code that contains the request and response functions.

When code is used, the runtime is required. The runtime value must be APPSYNC_JS .


codeS3Location?

Type: string (optional)

The Amazon S3 endpoint.


description?

Type: string (optional)

The Function description.


functionVersion?

Type: string (optional)

The version of the request mapping template.

Currently, only the 2018-05-29 version of the template is supported.


maxBatchSize?

Type: number (optional)

The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation.


requestMappingTemplate?

Type: string (optional)

The Function request mapping template.

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


requestMappingTemplateS3Location?

Type: string (optional)

Describes a Sync configuration for a resolver.

Contains information on which Conflict Detection, as well as Resolution strategy, should be performed when the resolver is invoked.


responseMappingTemplate?

Type: string (optional)

The Function response mapping template.


responseMappingTemplateS3Location?

Type: string (optional)

The location of a response mapping template in an Amazon S3 bucket.

Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template.


runtime?

Type: IResolvable | AppSyncRuntimeProperty (optional)

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.


syncConfig?

Type: IResolvable | SyncConfigProperty (optional)

Describes a Sync configuration for a resolver.

Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.

Properties

NameTypeDescription
apiIdstringThe AWS AppSync GraphQL API that you want to attach using this function.
attrDataSourceNamestringThe name of data source this function will attach.
attrFunctionArnstringARN of the function, such as arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/functions/functionId .
attrFunctionIdstringThe unique ID of this function.
attrNamestringThe name of the function.
cfnOptionsICfnResourceOptionsOptions for this resource, such as condition, update policy etc.
cfnProperties{ [string]: any }
cfnResourceTypestringAWS resource type.
creationStackstring[]
dataSourceNamestringThe name of data source this function will attach.
logicalIdstringThe logical ID for this CloudFormation stack element.
namestringThe name of the function.
nodeNodeThe tree node.
refstringReturn a string that will be resolved to a CloudFormation { Ref } for this element.
stackStackThe stack in which this element is defined.
code?stringThe resolver code that contains the request and response functions.
codeS3Location?stringThe Amazon S3 endpoint.
description?stringThe Function description.
functionVersion?stringThe version of the request mapping template.
maxBatchSize?numberThe maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation.
requestMappingTemplate?stringThe Function request mapping template.
requestMappingTemplateS3Location?stringDescribes a Sync configuration for a resolver.
responseMappingTemplate?stringThe Function response mapping template.
responseMappingTemplateS3Location?stringThe location of a response mapping template in an Amazon S3 bucket.
runtime?IResolvable | AppSyncRuntimePropertyDescribes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function.
syncConfig?IResolvable | SyncConfigPropertyDescribes a Sync configuration for a resolver.
static CFN_RESOURCE_TYPE_NAMEstringThe CloudFormation resource type name for this resource class.

apiId

Type: string

The AWS AppSync GraphQL API that you want to attach using this function.


attrDataSourceName

Type: string

The name of data source this function will attach.


attrFunctionArn

Type: string

ARN of the function, such as arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/functions/functionId .


attrFunctionId

Type: string

The unique ID of this function.


attrName

Type: string

The name of the function.


cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.


cfnProperties

Type: { [string]: any }


cfnResourceType

Type: string

AWS resource type.


creationStack

Type: string[]


dataSourceName

Type: string

The name of data source this function will attach.


logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).


name

Type: string

The name of the function.


node

Type: Node

The tree node.


ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).


stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).


code?

Type: string (optional)

The resolver code that contains the request and response functions.

When code is used, the runtime is required. The runtime value must be APPSYNC_JS .


codeS3Location?

Type: string (optional)

The Amazon S3 endpoint.


description?

Type: string (optional)

The Function description.


functionVersion?

Type: string (optional)

The version of the request mapping template.

Currently, only the 2018-05-29 version of the template is supported.


maxBatchSize?

Type: number (optional)

The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation.


requestMappingTemplate?

Type: string (optional)

The Function request mapping template.

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


requestMappingTemplateS3Location?

Type: string (optional)

Describes a Sync configuration for a resolver.

Contains information on which Conflict Detection, as well as Resolution strategy, should be performed when the resolver is invoked.


responseMappingTemplate?

Type: string (optional)

The Function response mapping template.


responseMappingTemplateS3Location?

Type: string (optional)

The location of a response mapping template in an Amazon S3 bucket.

Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template.


runtime?

Type: IResolvable | AppSyncRuntimeProperty (optional)

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.


syncConfig?

Type: IResolvable | SyncConfigProperty (optional)

Describes a Sync configuration for a resolver.

Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.


static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

NameDescription
addDeletionOverride(path)Syntactic sugar for addOverride(path, undefined).
addDependency(target)Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)Returns a token for an runtime attribute of this resource.
getMetadata(key)Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)Examines the CloudFormation resource and discloses attributes.
obtainDependencies()Retrieves an array of resources this resource depends on.
obtainResourceDependencies()Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)Replaces one dependency with another.
toString()Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

  • path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).


addDependency(target)

public addDependency(target: CfnResource): void

Parameters

  • target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.


addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

  • target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.


addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

  • key string
  • value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)


addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

  • path string — - The path of the property, you can use dot notation to override values in complex types.
  • value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.


addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

  • propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.


addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

  • propertyPath string — The path of the property.
  • value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).


applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

  • policy RemovalPolicy
  • options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options


getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

  • attributeName string — The name of the attribute.
  • typeHint ResolutionTypeHint

Returns

  • Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.


getMetadata(key)

public getMetadata(key: string): any

Parameters

  • key string

Returns

  • any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)


inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

  • inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.


obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

  • Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.


obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

  • CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.


overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

  • newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.


removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

  • target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.


replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

  • target CfnResource — The dependency to replace.
  • newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.


toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.


protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

  • props { [string]: any }

Returns

  • { [string]: any }