Class CfnFunctionConfiguration
The AWS::AppSync::FunctionConfiguration
resource defines the functions in GraphQL APIs to perform certain operations.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.AppSync
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnFunctionConfiguration : CfnResource, IInspectable
Syntax (vb)
Public Class CfnFunctionConfiguration
Inherits CfnResource
Implements IInspectable
Remarks
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 .
CloudformationResource: AWS::AppSync::FunctionConfiguration
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppSync;
var cfnFunctionConfiguration = new CfnFunctionConfiguration(this, "MyCfnFunctionConfiguration", new CfnFunctionConfigurationProps {
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 = new AppSyncRuntimeProperty {
Name = "name",
RuntimeVersion = "runtimeVersion"
},
SyncConfig = new SyncConfigProperty {
ConflictDetection = "conflictDetection",
// the properties below are optional
ConflictHandler = "conflictHandler",
LambdaConflictHandlerConfig = new LambdaConflictHandlerConfigProperty {
LambdaConflictHandlerArn = "lambdaConflictHandlerArn"
}
}
});
Synopsis
Constructors
CfnFunctionConfiguration(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnFunctionConfiguration(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnFunctionConfiguration(Construct, String, ICfnFunctionConfigurationProps) |
Properties
ApiId | The AWS AppSync GraphQL API that you want to attach using this function. |
AttrDataSourceName | The name of data source this function will attach. |
AttrFunctionArn | ARN of the function, such as |
AttrFunctionId | The unique ID of this function. |
AttrName | The name of the function. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Code | The |
CodeS3Location | The Amazon S3 endpoint. |
DataSourceName | The name of data source this function will attach. |
Description | The |
FunctionVersion | The version of the request mapping template. |
MaxBatchSize | The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a |
Name | The name of the function. |
RequestMappingTemplate | The |
RequestMappingTemplateS3Location | Describes a Sync configuration for a resolver. |
ResponseMappingTemplate | The |
ResponseMappingTemplateS3Location | The location of a response mapping template in an Amazon S3 bucket. |
Runtime | Describes a runtime used by an AWS AppSync resolver or AWS AppSync function. |
SyncConfig | Describes a Sync configuration for a resolver. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnFunctionConfiguration(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnFunctionConfiguration(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnFunctionConfiguration(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnFunctionConfiguration(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnFunctionConfiguration(Construct, String, ICfnFunctionConfigurationProps)
public CfnFunctionConfiguration(Construct scope, string id, ICfnFunctionConfigurationProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnFunctionConfigurationProps
Resource properties.
Properties
ApiId
The AWS AppSync GraphQL API that you want to attach using this function.
public virtual string ApiId { get; set; }
Property Value
System.String
AttrDataSourceName
The name of data source this function will attach.
public virtual string AttrDataSourceName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: DataSourceName
AttrFunctionArn
ARN of the function, such as arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/functions/functionId
.
public virtual string AttrFunctionArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: FunctionArn
AttrFunctionId
The unique ID of this function.
public virtual string AttrFunctionId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: FunctionId
AttrName
The name of the function.
public virtual string AttrName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Name
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Code
The resolver
code that contains the request and response functions.
public virtual string Code { get; set; }
Property Value
System.String
CodeS3Location
The Amazon S3 endpoint.
public virtual string CodeS3Location { get; set; }
Property Value
System.String
DataSourceName
The name of data source this function will attach.
public virtual string DataSourceName { get; set; }
Property Value
System.String
Description
The Function
description.
public virtual string Description { get; set; }
Property Value
System.String
FunctionVersion
The version of the request mapping template.
public virtual string FunctionVersion { get; set; }
Property Value
System.String
MaxBatchSize
The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke
operation.
public virtual Nullable<double> MaxBatchSize { get; set; }
Property Value
System.Nullable<System.Double>
Name
The name of the function.
public virtual string Name { get; set; }
Property Value
System.String
RequestMappingTemplate
The Function
request mapping template.
public virtual string RequestMappingTemplate { get; set; }
Property Value
System.String
RequestMappingTemplateS3Location
Describes a Sync configuration for a resolver.
public virtual string RequestMappingTemplateS3Location { get; set; }
Property Value
System.String
ResponseMappingTemplate
The Function
response mapping template.
public virtual string ResponseMappingTemplate { get; set; }
Property Value
System.String
ResponseMappingTemplateS3Location
The location of a response mapping template in an Amazon S3 bucket.
public virtual string ResponseMappingTemplateS3Location { get; set; }
Property Value
System.String
Runtime
Describes a runtime used by an AWS AppSync resolver or AWS AppSync function.
public virtual object Runtime { get; set; }
Property Value
System.Object
SyncConfig
Describes a Sync configuration for a resolver.
public virtual object SyncConfig { get; set; }
Property Value
System.Object
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>