We recommend new projects start with resources from the AWS provider.
aws-native.appsync.FunctionConfiguration
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
An example resource schema demonstrating some basic constructs and validation rules.
Create FunctionConfiguration Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new FunctionConfiguration(name: string, args: FunctionConfigurationArgs, opts?: CustomResourceOptions);
@overload
def FunctionConfiguration(resource_name: str,
args: FunctionConfigurationArgs,
opts: Optional[ResourceOptions] = None)
@overload
def FunctionConfiguration(resource_name: str,
opts: Optional[ResourceOptions] = None,
data_source_name: Optional[str] = None,
api_id: Optional[str] = None,
max_batch_size: Optional[int] = None,
code_s3_location: Optional[str] = None,
description: Optional[str] = None,
function_version: Optional[str] = None,
code: Optional[str] = None,
name: Optional[str] = None,
request_mapping_template: Optional[str] = None,
request_mapping_template_s3_location: Optional[str] = None,
response_mapping_template: Optional[str] = None,
response_mapping_template_s3_location: Optional[str] = None,
runtime: Optional[FunctionConfigurationAppSyncRuntimeArgs] = None,
sync_config: Optional[FunctionConfigurationSyncConfigArgs] = None)
func NewFunctionConfiguration(ctx *Context, name string, args FunctionConfigurationArgs, opts ...ResourceOption) (*FunctionConfiguration, error)
public FunctionConfiguration(string name, FunctionConfigurationArgs args, CustomResourceOptions? opts = null)
public FunctionConfiguration(String name, FunctionConfigurationArgs args)
public FunctionConfiguration(String name, FunctionConfigurationArgs args, CustomResourceOptions options)
type: aws-native:appsync:FunctionConfiguration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. FunctionConfigurationArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. FunctionConfigurationArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. FunctionConfigurationArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. FunctionConfigurationArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. FunctionConfigurationArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
FunctionConfiguration Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The FunctionConfiguration resource accepts the following input properties:
- Api
Id This property is required. string - The AWS AppSync GraphQL API that you want to attach using this function.
- Data
Source Name This property is required. string - The name of data source this function will attach.
- Code string
- 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.
- Code
S3Location string - The Amazon S3 endpoint (where the code is located??).
- Description string
- The function description.
- Function
Version string - The version of the request mapping template. Currently, only the 2018-05-29 version of the template is supported.
- Max
Batch intSize - The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation.
- Name string
- The name of the function.
- Request
Mapping stringTemplate - The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
- Request
Mapping stringTemplate S3Location - 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.
- Response
Mapping stringTemplate - The Function response mapping template.
- Response
Mapping stringTemplate S3Location - 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
Pulumi.
Aws Native. App Sync. Inputs. Function Configuration App Sync Runtime - 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.
- Sync
Config Pulumi.Aws Native. App Sync. Inputs. Function Configuration Sync Config - Describes a Sync configuration for a resolver. Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.
- Api
Id This property is required. string - The AWS AppSync GraphQL API that you want to attach using this function.
- Data
Source Name This property is required. string - The name of data source this function will attach.
- Code string
- 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.
- Code
S3Location string - The Amazon S3 endpoint (where the code is located??).
- Description string
- The function description.
- Function
Version string - The version of the request mapping template. Currently, only the 2018-05-29 version of the template is supported.
- Max
Batch intSize - The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation.
- Name string
- The name of the function.
- Request
Mapping stringTemplate - The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
- Request
Mapping stringTemplate S3Location - 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.
- Response
Mapping stringTemplate - The Function response mapping template.
- Response
Mapping stringTemplate S3Location - 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
Function
Configuration App Sync Runtime Args - 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.
- Sync
Config FunctionConfiguration Sync Config Args - Describes a Sync configuration for a resolver. Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.
- api
Id This property is required. String - The AWS AppSync GraphQL API that you want to attach using this function.
- data
Source Name This property is required. String - The name of data source this function will attach.
- code String
- 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.
- code
S3Location String - The Amazon S3 endpoint (where the code is located??).
- description String
- The function description.
- function
Version String - The version of the request mapping template. Currently, only the 2018-05-29 version of the template is supported.
- max
Batch IntegerSize - The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation.
- name String
- The name of the function.
- request
Mapping StringTemplate - The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
- request
Mapping StringTemplate S3Location - 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.
- response
Mapping StringTemplate - The Function response mapping template.
- response
Mapping StringTemplate S3Location - 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
Function
Configuration App Sync Runtime - 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.
- sync
Config FunctionConfiguration Sync Config - Describes a Sync configuration for a resolver. Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.
- api
Id This property is required. string - The AWS AppSync GraphQL API that you want to attach using this function.
- data
Source Name This property is required. string - The name of data source this function will attach.
- code string
- 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.
- code
S3Location string - The Amazon S3 endpoint (where the code is located??).
- description string
- The function description.
- function
Version string - The version of the request mapping template. Currently, only the 2018-05-29 version of the template is supported.
- max
Batch numberSize - The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation.
- name string
- The name of the function.
- request
Mapping stringTemplate - The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
- request
Mapping stringTemplate S3Location - 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.
- response
Mapping stringTemplate - The Function response mapping template.
- response
Mapping stringTemplate S3Location - 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
Function
Configuration App Sync Runtime - 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.
- sync
Config FunctionConfiguration Sync Config - Describes a Sync configuration for a resolver. Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.
- api_
id This property is required. str - The AWS AppSync GraphQL API that you want to attach using this function.
- data_
source_ name This property is required. str - The name of data source this function will attach.
- code str
- 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.
- code_
s3_ strlocation - The Amazon S3 endpoint (where the code is located??).
- description str
- The function description.
- function_
version str - The version of the request mapping template. Currently, only the 2018-05-29 version of the template is supported.
- max_
batch_ intsize - The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation.
- name str
- The name of the function.
- request_
mapping_ strtemplate - The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
- request_
mapping_ strtemplate_ s3_ location - 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.
- response_
mapping_ strtemplate - The Function response mapping template.
- response_
mapping_ strtemplate_ s3_ location - 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
Function
Configuration App Sync Runtime Args - 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.
- sync_
config FunctionConfiguration Sync Config Args - Describes a Sync configuration for a resolver. Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.
- api
Id This property is required. String - The AWS AppSync GraphQL API that you want to attach using this function.
- data
Source Name This property is required. String - The name of data source this function will attach.
- code String
- 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.
- code
S3Location String - The Amazon S3 endpoint (where the code is located??).
- description String
- The function description.
- function
Version String - The version of the request mapping template. Currently, only the 2018-05-29 version of the template is supported.
- max
Batch NumberSize - The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation.
- name String
- The name of the function.
- request
Mapping StringTemplate - The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
- request
Mapping StringTemplate S3Location - 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.
- response
Mapping StringTemplate - The Function response mapping template.
- response
Mapping StringTemplate S3Location - 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 Property Map
- 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.
- sync
Config Property Map - Describes a Sync configuration for a resolver. Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.
Outputs
All input properties are implicitly available as output properties. Additionally, the FunctionConfiguration resource produces the following output properties:
- Function
Arn string - The ARN for the function generated by the service
- Function
Id string - The unique identifier for the function generated by the service
- Id string
- The provider-assigned unique ID for this managed resource.
- Function
Arn string - The ARN for the function generated by the service
- Function
Id string - The unique identifier for the function generated by the service
- Id string
- The provider-assigned unique ID for this managed resource.
- function
Arn String - The ARN for the function generated by the service
- function
Id String - The unique identifier for the function generated by the service
- id String
- The provider-assigned unique ID for this managed resource.
- function
Arn string - The ARN for the function generated by the service
- function
Id string - The unique identifier for the function generated by the service
- id string
- The provider-assigned unique ID for this managed resource.
- function_
arn str - The ARN for the function generated by the service
- function_
id str - The unique identifier for the function generated by the service
- id str
- The provider-assigned unique ID for this managed resource.
- function
Arn String - The ARN for the function generated by the service
- function
Id String - The unique identifier for the function generated by the service
- id String
- The provider-assigned unique ID for this managed resource.
Supporting Types
FunctionConfigurationAppSyncRuntime, FunctionConfigurationAppSyncRuntimeArgs
- Name
This property is required. string - The name of the runtime to use. Currently, the only allowed value is APPSYNC_JS.
- Runtime
Version This property is required. string - The version of the runtime to use. Currently, the only allowed version is 1.0.0.
- Name
This property is required. string - The name of the runtime to use. Currently, the only allowed value is APPSYNC_JS.
- Runtime
Version This property is required. string - The version of the runtime to use. Currently, the only allowed version is 1.0.0.
- name
This property is required. String - The name of the runtime to use. Currently, the only allowed value is APPSYNC_JS.
- runtime
Version This property is required. String - The version of the runtime to use. Currently, the only allowed version is 1.0.0.
- name
This property is required. string - The name of the runtime to use. Currently, the only allowed value is APPSYNC_JS.
- runtime
Version This property is required. string - The version of the runtime to use. Currently, the only allowed version is 1.0.0.
- name
This property is required. str - The name of the runtime to use. Currently, the only allowed value is APPSYNC_JS.
- runtime_
version This property is required. str - The version of the runtime to use. Currently, the only allowed version is 1.0.0.
- name
This property is required. String - The name of the runtime to use. Currently, the only allowed value is APPSYNC_JS.
- runtime
Version This property is required. String - The version of the runtime to use. Currently, the only allowed version is 1.0.0.
FunctionConfigurationLambdaConflictHandlerConfig, FunctionConfigurationLambdaConflictHandlerConfigArgs
- Lambda
Conflict stringHandler Arn - The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.
- Lambda
Conflict stringHandler Arn - The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.
- lambda
Conflict StringHandler Arn - The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.
- lambda
Conflict stringHandler Arn - The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.
- lambda_
conflict_ strhandler_ arn - The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.
- lambda
Conflict StringHandler Arn - The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.
FunctionConfigurationSyncConfig, FunctionConfigurationSyncConfigArgs
- Conflict
Detection This property is required. string - The Conflict Detection strategy to use.
- Conflict
Handler string - The Conflict Resolution strategy to perform in the event of a conflict.
- Lambda
Conflict Pulumi.Handler Config Aws Native. App Sync. Inputs. Function Configuration Lambda Conflict Handler Config - The
LambdaConflictHandlerConfig
when configuringLAMBDA
as the Conflict Handler.
- Conflict
Detection This property is required. string - The Conflict Detection strategy to use.
- Conflict
Handler string - The Conflict Resolution strategy to perform in the event of a conflict.
- Lambda
Conflict FunctionHandler Config Configuration Lambda Conflict Handler Config - The
LambdaConflictHandlerConfig
when configuringLAMBDA
as the Conflict Handler.
- conflict
Detection This property is required. String - The Conflict Detection strategy to use.
- conflict
Handler String - The Conflict Resolution strategy to perform in the event of a conflict.
- lambda
Conflict FunctionHandler Config Configuration Lambda Conflict Handler Config - The
LambdaConflictHandlerConfig
when configuringLAMBDA
as the Conflict Handler.
- conflict
Detection This property is required. string - The Conflict Detection strategy to use.
- conflict
Handler string - The Conflict Resolution strategy to perform in the event of a conflict.
- lambda
Conflict FunctionHandler Config Configuration Lambda Conflict Handler Config - The
LambdaConflictHandlerConfig
when configuringLAMBDA
as the Conflict Handler.
- conflict_
detection This property is required. str - The Conflict Detection strategy to use.
- conflict_
handler str - The Conflict Resolution strategy to perform in the event of a conflict.
- lambda_
conflict_ Functionhandler_ config Configuration Lambda Conflict Handler Config - The
LambdaConflictHandlerConfig
when configuringLAMBDA
as the Conflict Handler.
- conflict
Detection This property is required. String - The Conflict Detection strategy to use.
- conflict
Handler String - The Conflict Resolution strategy to perform in the event of a conflict.
- lambda
Conflict Property MapHandler Config - The
LambdaConflictHandlerConfig
when configuringLAMBDA
as the Conflict Handler.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.