Class CfnFunctionConfiguration
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.appsync.CfnFunctionConfiguration
- All Implemented Interfaces:
IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-11T15:55:53.412Z")
@Stability(Stable)
public class CfnFunctionConfiguration
extends CfnResource
implements IInspectable
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 software.amazon.awscdk.services.appsync.*; CfnFunctionConfiguration cfnFunctionConfiguration = CfnFunctionConfiguration.Builder.create(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(AppSyncRuntimeProperty.builder() .name("name") .runtimeVersion("runtimeVersion") .build()) .syncConfig(SyncConfigProperty.builder() .conflictDetection("conflictDetection") // the properties below are optional .conflictHandler("conflictHandler") .lambdaConflictHandlerConfig(LambdaConflictHandlerConfigProperty.builder() .lambdaConflictHandlerArn("lambdaConflictHandlerArn") .build()) .build()) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
Describes a runtime used by an AWS AppSync resolver or AWS AppSync function.static final class
A fluent builder forCfnFunctionConfiguration
.static interface
TheLambdaConflictHandlerConfig
object when configuringLAMBDA
as the Conflict Handler.static interface
Describes a Sync configuration for a resolver.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnFunctionConfiguration
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnFunctionConfiguration
(software.amazon.jsii.JsiiObjectRef objRef) CfnFunctionConfiguration
(software.constructs.Construct scope, String id, CfnFunctionConfigurationProps props) -
Method Summary
Modifier and TypeMethodDescriptiongetApiId()
The AWS AppSync GraphQL API that you want to attach using this function.The name of data source this function will attach.ARN of the function, such asarn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/functions/functionId
.The unique ID of this function.The name of the function.getCode()
Theresolver
code that contains the request and response functions.The Amazon S3 endpoint.The name of data source this function will attach.TheFunction
description.The version of the request mapping template.The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in aBatchInvoke
operation.getName()
The name of the function.TheFunction
request mapping template.Describes a Sync configuration for a resolver.TheFunction
response mapping template.The location of a response mapping template in an Amazon S3 bucket.Describes a runtime used by an AWS AppSync resolver or AWS AppSync function.Describes a Sync configuration for a resolver.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
The AWS AppSync GraphQL API that you want to attach using this function.void
Theresolver
code that contains the request and response functions.void
setCodeS3Location
(String value) The Amazon S3 endpoint.void
setDataSourceName
(String value) The name of data source this function will attach.void
setDescription
(String value) TheFunction
description.void
setFunctionVersion
(String value) The version of the request mapping template.void
setMaxBatchSize
(Number value) The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in aBatchInvoke
operation.void
The name of the function.void
setRequestMappingTemplate
(String value) TheFunction
request mapping template.void
Describes a Sync configuration for a resolver.void
setResponseMappingTemplate
(String value) TheFunction
response mapping template.void
The location of a response mapping template in an Amazon S3 bucket.void
setRuntime
(IResolvable value) Describes a runtime used by an AWS AppSync resolver or AWS AppSync function.void
Describes a runtime used by an AWS AppSync resolver or AWS AppSync function.void
setSyncConfig
(IResolvable value) Describes a Sync configuration for a resolver.void
Describes a Sync configuration for a resolver.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
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.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnFunctionConfiguration
protected CfnFunctionConfiguration(software.amazon.jsii.JsiiObjectRef objRef) -
CfnFunctionConfiguration
protected CfnFunctionConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnFunctionConfiguration
@Stability(Stable) public CfnFunctionConfiguration(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnFunctionConfigurationProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrDataSourceName
The name of data source this function will attach. -
getAttrFunctionArn
ARN of the function, such asarn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/functions/functionId
. -
getAttrFunctionId
The unique ID of this function. -
getAttrName
The name of the function. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getApiId
The AWS AppSync GraphQL API that you want to attach using this function. -
setApiId
The AWS AppSync GraphQL API that you want to attach using this function. -
getDataSourceName
The name of data source this function will attach. -
setDataSourceName
The name of data source this function will attach. -
getName
The name of the function. -
setName
The name of the function. -
getCode
Theresolver
code that contains the request and response functions. -
setCode
Theresolver
code that contains the request and response functions. -
getCodeS3Location
The Amazon S3 endpoint. -
setCodeS3Location
The Amazon S3 endpoint. -
getDescription
TheFunction
description. -
setDescription
TheFunction
description. -
getFunctionVersion
The version of the request mapping template. -
setFunctionVersion
The version of the request mapping template. -
getMaxBatchSize
The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in aBatchInvoke
operation. -
setMaxBatchSize
The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in aBatchInvoke
operation. -
getRequestMappingTemplate
TheFunction
request mapping template. -
setRequestMappingTemplate
TheFunction
request mapping template. -
getRequestMappingTemplateS3Location
Describes a Sync configuration for a resolver. -
setRequestMappingTemplateS3Location
Describes a Sync configuration for a resolver. -
getResponseMappingTemplate
TheFunction
response mapping template. -
setResponseMappingTemplate
TheFunction
response mapping template. -
getResponseMappingTemplateS3Location
The location of a response mapping template in an Amazon S3 bucket. -
setResponseMappingTemplateS3Location
The location of a response mapping template in an Amazon S3 bucket. -
getRuntime
Describes a runtime used by an AWS AppSync resolver or AWS AppSync function. -
setRuntime
Describes a runtime used by an AWS AppSync resolver or AWS AppSync function. -
setRuntime
@Stability(Stable) public void setRuntime(@Nullable CfnFunctionConfiguration.AppSyncRuntimeProperty value) Describes a runtime used by an AWS AppSync resolver or AWS AppSync function. -
getSyncConfig
Describes a Sync configuration for a resolver. -
setSyncConfig
Describes a Sync configuration for a resolver. -
setSyncConfig
@Stability(Stable) public void setSyncConfig(@Nullable CfnFunctionConfiguration.SyncConfigProperty value) Describes a Sync configuration for a resolver.
-