Amazonka.AppSync.CreateResolver

Creates a Resolver object.

A resolver converts incoming requests into a format that a data source can understand, and converts the data source's responses into GraphQL.

Creating a Request

data CreateResolver

See: newCreateResolver smart constructor.

Constructors

CreateResolver'

Fields

• cachingConfig :: Maybe CachingConfig

  The caching configuration for the resolver.

• code :: Maybe Text

  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.

• dataSourceName :: Maybe Text

  The name of the data source for which the resolver is being created.

• kind :: Maybe ResolverKind

  The resolver type.

  • UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
  • PIPELINE: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of Function objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.
• maxBatchSize :: Maybe Natural

  The maximum batching size for a resolver.

• pipelineConfig :: Maybe PipelineConfig

  The PipelineConfig.

• requestMappingTemplate :: Maybe Text

  The mapping template to use for requests.

  A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source can understand. Mapping templates are written in Apache Velocity Template Language (VTL).

  VTL request mapping templates are optional when using an Lambda data source. For all other data sources, VTL request and response mapping templates are required.

• responseMappingTemplate :: Maybe Text

  The mapping template to use for responses from the data source.

• runtime :: Maybe AppSyncRuntime
• syncConfig :: Maybe SyncConfig

  The SyncConfig for a resolver attached to a versioned data source.

• apiId :: Text

  The ID for the GraphQL API for which the resolver is being created.

• typeName :: Text

  The name of the Type.

• fieldName :: Text

  The name of the field to attach the resolver to.

Instances

ToJSON CreateResolver

Defined in Amazonka.AppSync.CreateResolver

Methods

toJSON :: CreateResolver -> Value

toEncoding :: CreateResolver -> Encoding

toJSONList :: [CreateResolver] -> Value

toEncodingList :: [CreateResolver] -> Encoding

ToHeaders CreateResolver

Defined in Amazonka.AppSync.CreateResolver

Methods

toHeaders :: CreateResolver -> [Header]

ToPath CreateResolver

Defined in Amazonka.AppSync.CreateResolver

Methods

toPath :: CreateResolver -> ByteString

ToQuery CreateResolver

Defined in Amazonka.AppSync.CreateResolver

Methods

toQuery :: CreateResolver -> QueryString

AWSRequest CreateResolver

Defined in Amazonka.AppSync.CreateResolver

Associated Types

type AWSResponse CreateResolver

Methods

request :: (Service -> Service) -> CreateResolver -> Request CreateResolver

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateResolver -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateResolver)))

Generic CreateResolver

Defined in Amazonka.AppSync.CreateResolver

Associated Types

type Rep CreateResolver :: Type -> Type

Methods

from :: CreateResolver -> Rep CreateResolver x

to :: Rep CreateResolver x -> CreateResolver

Read CreateResolver

Defined in Amazonka.AppSync.CreateResolver

Methods

readsPrec :: Int -> ReadS CreateResolver

readList :: ReadS [CreateResolver]

readPrec :: ReadPrec CreateResolver

readListPrec :: ReadPrec [CreateResolver]

Show CreateResolver

Defined in Amazonka.AppSync.CreateResolver

Methods

showsPrec :: Int -> CreateResolver -> ShowS

show :: CreateResolver -> String

showList :: [CreateResolver] -> ShowS

NFData CreateResolver

Defined in Amazonka.AppSync.CreateResolver

Methods

rnf :: CreateResolver -> ()

Eq CreateResolver

Defined in Amazonka.AppSync.CreateResolver

Methods

(==) :: CreateResolver -> CreateResolver -> Bool

(/=) :: CreateResolver -> CreateResolver -> Bool

Hashable CreateResolver

Defined in Amazonka.AppSync.CreateResolver

Methods

hashWithSalt :: Int -> CreateResolver -> Int

hash :: CreateResolver -> Int

type AWSResponse CreateResolver

Defined in Amazonka.AppSync.CreateResolver

type AWSResponse CreateResolver = CreateResolverResponse

type Rep CreateResolver

Defined in Amazonka.AppSync.CreateResolver

type Rep CreateResolver = D1 ('MetaData "CreateResolver" "Amazonka.AppSync.CreateResolver" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" 'False) (C1 ('MetaCons "CreateResolver'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cachingConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CachingConfig)) :*: (S1 ('MetaSel ('Just "code") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dataSourceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "kind") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResolverKind)) :*: (S1 ('MetaSel ('Just "maxBatchSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "pipelineConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PipelineConfig))))) :*: ((S1 ('MetaSel ('Just "requestMappingTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "responseMappingTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "runtime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AppSyncRuntime)))) :*: ((S1 ('MetaSel ('Just "syncConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SyncConfig)) :*: S1 ('MetaSel ('Just "apiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "typeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "fieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateResolver

Arguments

:: Text

CreateResolver

-> Text

CreateResolver

-> Text

CreateResolver

-> CreateResolver

Create a value of CreateResolver with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateResolver, createResolver_cachingConfig - The caching configuration for the resolver.

CreateResolver, createResolver_code - 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.

CreateResolver, createResolver_dataSourceName - The name of the data source for which the resolver is being created.

CreateResolver, createResolver_kind - The resolver type.

• UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
• PIPELINE: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of Function objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.

CreateResolver, createResolver_maxBatchSize - The maximum batching size for a resolver.

CreateResolver, createResolver_pipelineConfig - The PipelineConfig.

CreateResolver, createResolver_requestMappingTemplate - The mapping template to use for requests.

A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source can understand. Mapping templates are written in Apache Velocity Template Language (VTL).

VTL request mapping templates are optional when using an Lambda data source. For all other data sources, VTL request and response mapping templates are required.

CreateResolver, createResolver_responseMappingTemplate - The mapping template to use for responses from the data source.

CreateResolver, createResolver_runtime - Undocumented member.

CreateResolver, createResolver_syncConfig - The SyncConfig for a resolver attached to a versioned data source.

CreateResolver, createResolver_apiId - The ID for the GraphQL API for which the resolver is being created.

CreateResolver, createResolver_typeName - The name of the Type.

CreateResolver, createResolver_fieldName - The name of the field to attach the resolver to.

Request Lenses

createResolver_cachingConfig :: Lens' CreateResolver (Maybe CachingConfig)

The caching configuration for the resolver.

createResolver_code :: Lens' CreateResolver (Maybe Text)

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.

createResolver_dataSourceName :: Lens' CreateResolver (Maybe Text)

The name of the data source for which the resolver is being created.

createResolver_kind :: Lens' CreateResolver (Maybe ResolverKind)

The resolver type.

• UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
• PIPELINE: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of Function objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.

createResolver_maxBatchSize :: Lens' CreateResolver (Maybe Natural)

The maximum batching size for a resolver.

createResolver_pipelineConfig :: Lens' CreateResolver (Maybe PipelineConfig)

The PipelineConfig.

createResolver_requestMappingTemplate :: Lens' CreateResolver (Maybe Text)

The mapping template to use for requests.

A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source can understand. Mapping templates are written in Apache Velocity Template Language (VTL).

VTL request mapping templates are optional when using an Lambda data source. For all other data sources, VTL request and response mapping templates are required.

createResolver_responseMappingTemplate :: Lens' CreateResolver (Maybe Text)

The mapping template to use for responses from the data source.

createResolver_runtime :: Lens' CreateResolver (Maybe AppSyncRuntime)

Undocumented member.

createResolver_syncConfig :: Lens' CreateResolver (Maybe SyncConfig)

The SyncConfig for a resolver attached to a versioned data source.

createResolver_apiId :: Lens' CreateResolver Text

The ID for the GraphQL API for which the resolver is being created.

createResolver_typeName :: Lens' CreateResolver Text

The name of the Type.

createResolver_fieldName :: Lens' CreateResolver Text

The name of the field to attach the resolver to.

Destructuring the Response

data CreateResolverResponse

See: newCreateResolverResponse smart constructor.

Constructors

CreateResolverResponse'

Fields

• resolver :: Maybe Resolver

  The Resolver object.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateResolverResponse

Defined in Amazonka.AppSync.CreateResolver

Associated Types

type Rep CreateResolverResponse :: Type -> Type

Methods

from :: CreateResolverResponse -> Rep CreateResolverResponse x

to :: Rep CreateResolverResponse x -> CreateResolverResponse

Read CreateResolverResponse

Defined in Amazonka.AppSync.CreateResolver

Methods

readsPrec :: Int -> ReadS CreateResolverResponse

readList :: ReadS [CreateResolverResponse]

readPrec :: ReadPrec CreateResolverResponse

readListPrec :: ReadPrec [CreateResolverResponse]

Show CreateResolverResponse

Defined in Amazonka.AppSync.CreateResolver

Methods

showsPrec :: Int -> CreateResolverResponse -> ShowS

show :: CreateResolverResponse -> String

showList :: [CreateResolverResponse] -> ShowS

NFData CreateResolverResponse

Defined in Amazonka.AppSync.CreateResolver

Methods

rnf :: CreateResolverResponse -> ()

Eq CreateResolverResponse

Defined in Amazonka.AppSync.CreateResolver

Methods

(==) :: CreateResolverResponse -> CreateResolverResponse -> Bool

(/=) :: CreateResolverResponse -> CreateResolverResponse -> Bool

type Rep CreateResolverResponse

Defined in Amazonka.AppSync.CreateResolver

type Rep CreateResolverResponse = D1 ('MetaData "CreateResolverResponse" "Amazonka.AppSync.CreateResolver" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" 'False) (C1 ('MetaCons "CreateResolverResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resolver") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Resolver)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateResolverResponse

Arguments

:: Int

$sel:httpStatus:CreateResolverResponse'

-> CreateResolverResponse

Create a value of CreateResolverResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:resolver:CreateResolverResponse', createResolverResponse_resolver - The Resolver object.

$sel:httpStatus:CreateResolverResponse', createResolverResponse_httpStatus - The response's http status code.

Response Lenses

createResolverResponse_resolver :: Lens' CreateResolverResponse (Maybe Resolver)

The Resolver object.

createResolverResponse_httpStatus :: Lens' CreateResolverResponse Int

The response's http status code.