[ aws . appsync ]

create-function

Description

Creates a Function object.

A function is a reusable entity. Multiple functions can be used to compose the resolver logic.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-function
--api-id <value>
--name <value>
[--description <value>]
--data-source-name <value>
[--request-mapping-template <value>]
[--response-mapping-template <value>]
--function-version <value>
[--sync-config <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--api-id (string)

The GraphQL API ID.

--name (string)

The Function name. The function name does not have to be unique.

--description (string)

The Function description.

--data-source-name (string)

The Function DataSource name.

--request-mapping-template (string)

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

--response-mapping-template (string)

The Function response mapping template.

--function-version (string)

The version of the request mapping template. Currently the supported value is 2018-05-29.

--sync-config (structure)

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.

conflictHandler -> (string)

The Conflict Resolution strategy to perform in the event of a conflict.

• OPTIMISTIC_CONCURRENCY : Resolve conflicts by rejecting mutations when versions do not match the latest version at the server.

• AUTOMERGE : Resolve conflicts with the Automerge conflict resolution strategy.

• LAMBDA : Resolve conflicts with a Lambda function supplied in the LambdaConflictHandlerConfig.

conflictDetection -> (string)

The Conflict Detection strategy to use.

• VERSION : Detect conflicts based on object versions for this resolver.

• NONE : Do not detect conflicts when executing this resolver.

lambdaConflictHandlerConfig -> (structure)

The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.

lambdaConflictHandlerArn -> (string)

The Arn for the Lambda function to use as the Conflict Handler.

Shorthand Syntax:

conflictHandler=string,conflictDetection=string,lambdaConflictHandlerConfig={lambdaConflictHandlerArn=string}

JSON Syntax:

{
  "conflictHandler": "OPTIMISTIC_CONCURRENCY"|"LAMBDA"|"AUTOMERGE"|"NONE",
  "conflictDetection": "VERSION"|"NONE",
  "lambdaConflictHandlerConfig": {
    "lambdaConflictHandlerArn": "string"
  }
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

functionConfiguration -> (structure)

The Function object.

functionId -> (string)

A unique ID representing the Function object.

functionArn -> (string)

The ARN of the Function object.

name -> (string)

The name of the Function object.

description -> (string)

The Function description.

dataSourceName -> (string)

The name of the DataSource .

requestMappingTemplate -> (string)

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

responseMappingTemplate -> (string)

The Function response mapping template.

functionVersion -> (string)

The version of the request mapping template. Currently only the 2018-05-29 version of the template is supported.

syncConfig -> (structure)

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.

conflictHandler -> (string)

The Conflict Resolution strategy to perform in the event of a conflict.

• OPTIMISTIC_CONCURRENCY : Resolve conflicts by rejecting mutations when versions do not match the latest version at the server.

• AUTOMERGE : Resolve conflicts with the Automerge conflict resolution strategy.

• LAMBDA : Resolve conflicts with a Lambda function supplied in the LambdaConflictHandlerConfig.

conflictDetection -> (string)

The Conflict Detection strategy to use.

• VERSION : Detect conflicts based on object versions for this resolver.

• NONE : Do not detect conflicts when executing this resolver.

lambdaConflictHandlerConfig -> (structure)

The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.

lambdaConflictHandlerArn -> (string)

The Arn for the Lambda function to use as the Conflict Handler.