Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.AppSync.CreateResolver

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

data CreateResolver = CreateResolver' {
- dataSourceName :: Maybe Text
- requestMappingTemplate :: Maybe Text
- kind :: Maybe ResolverKind
- cachingConfig :: Maybe CachingConfig
- responseMappingTemplate :: Maybe Text
- syncConfig :: Maybe SyncConfig
- pipelineConfig :: Maybe PipelineConfig
- apiId :: Text
- typeName :: Text
- fieldName :: Text
}
newCreateResolver :: Text -> Text -> Text -> CreateResolver
createResolver_dataSourceName :: Lens' CreateResolver (Maybe Text)
createResolver_requestMappingTemplate :: Lens' CreateResolver (Maybe Text)
createResolver_kind :: Lens' CreateResolver (Maybe ResolverKind)
createResolver_cachingConfig :: Lens' CreateResolver (Maybe CachingConfig)
createResolver_responseMappingTemplate :: Lens' CreateResolver (Maybe Text)
createResolver_syncConfig :: Lens' CreateResolver (Maybe SyncConfig)
createResolver_pipelineConfig :: Lens' CreateResolver (Maybe PipelineConfig)
createResolver_apiId :: Lens' CreateResolver Text
createResolver_typeName :: Lens' CreateResolver Text
createResolver_fieldName :: Lens' CreateResolver Text
data CreateResolverResponse = CreateResolverResponse' {
- resolver :: Maybe Resolver
- httpStatus :: Int
}
newCreateResolverResponse :: Int -> CreateResolverResponse
createResolverResponse_resolver :: Lens' CreateResolverResponse (Maybe Resolver)
createResolverResponse_httpStatus :: Lens' CreateResolverResponse Int

Creating a Request

data CreateResolver Source #

See: newCreateResolver smart constructor.

Constructors

CreateResolver'

Fields

dataSourceName :: Maybe Text
The name of the data source for which the resolver is being created.
requestMappingTemplate :: Maybe Text
The mapping template to be used 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 a Lambda data source. For all other data sources, VTL request and response mapping templates are required.
kind :: Maybe ResolverKind
The resolver type.
- UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source.
- PIPELINE: A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of Function in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.
cachingConfig :: Maybe CachingConfig
The caching configuration for the resolver.
responseMappingTemplate :: Maybe Text
The mapping template to be used for responses from the data source.
syncConfig :: Maybe SyncConfig
The SyncConfig for a resolver attached to a versioned datasource.
pipelineConfig :: Maybe PipelineConfig
The PipelineConfig.
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

Instances details

Eq CreateResolver Source #
Instance details Defined in Amazonka.AppSync.CreateResolver Methods (==) :: CreateResolver -> CreateResolver -> Bool # (/=) :: CreateResolver -> CreateResolver -> Bool #
Read CreateResolver Source #
Instance details Defined in Amazonka.AppSync.CreateResolver Methods readsPrec :: Int -> ReadS CreateResolver # readList :: ReadS [CreateResolver] # readPrec :: ReadPrec CreateResolver # readListPrec :: ReadPrec [CreateResolver] #
Show CreateResolver Source #
Instance details Defined in Amazonka.AppSync.CreateResolver Methods showsPrec :: Int -> CreateResolver -> ShowS # show :: CreateResolver -> String # showList :: [CreateResolver] -> ShowS #
Generic CreateResolver Source #
Instance details Defined in Amazonka.AppSync.CreateResolver Associated Types type Rep CreateResolver :: Type -> Type # Methods from :: CreateResolver -> Rep CreateResolver x # to :: Rep CreateResolver x -> CreateResolver #
NFData CreateResolver Source #
Instance details Defined in Amazonka.AppSync.CreateResolver Methods rnf :: CreateResolver -> () #
Hashable CreateResolver Source #
Instance details Defined in Amazonka.AppSync.CreateResolver Methods hashWithSalt :: Int -> CreateResolver -> Int # hash :: CreateResolver -> Int #
ToJSON CreateResolver Source #
Instance details Defined in Amazonka.AppSync.CreateResolver Methods toJSON :: CreateResolver -> Value # toEncoding :: CreateResolver -> Encoding # toJSONList :: [CreateResolver] -> Value # toEncodingList :: [CreateResolver] -> Encoding #
AWSRequest CreateResolver Source #
Instance details Defined in Amazonka.AppSync.CreateResolver Associated Types type AWSResponse CreateResolver # Methods request :: CreateResolver -> Request CreateResolver # response :: MonadResource m => Logger -> Service -> Proxy CreateResolver -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateResolver))) #
ToHeaders CreateResolver Source #
Instance details Defined in Amazonka.AppSync.CreateResolver Methods toHeaders :: CreateResolver -> [Header] #
ToPath CreateResolver Source #
Instance details Defined in Amazonka.AppSync.CreateResolver Methods toPath :: CreateResolver -> ByteString #
ToQuery CreateResolver Source #
Instance details Defined in Amazonka.AppSync.CreateResolver Methods toQuery :: CreateResolver -> QueryString #
type Rep CreateResolver Source #
Instance details Defined in Amazonka.AppSync.CreateResolver type Rep CreateResolver = D1 ('MetaData "CreateResolver" "Amazonka.AppSync.CreateResolver" "libZSservicesZSamazonka-appsyncZSamazonka-appsync" 'False) (C1 ('MetaCons "CreateResolver'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "dataSourceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "requestMappingTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "kind") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResolverKind)) :: (S1 ('MetaSel ('Just "cachingConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CachingConfig)) :: S1 ('MetaSel ('Just "responseMappingTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "syncConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SyncConfig)) :: S1 ('MetaSel ('Just "pipelineConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PipelineConfig))) :: (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))))))
type AWSResponse CreateResolver Source #
Instance details Defined in Amazonka.AppSync.CreateResolver type AWSResponse CreateResolver = CreateResolverResponse

newCreateResolver Source #

Arguments

:: Text	`$sel:apiId:CreateResolver'`
-> Text	`$sel:typeName:CreateResolver'`
-> Text	`$sel:fieldName: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:

$sel:dataSourceName:CreateResolver', createResolver_dataSourceName - The name of the data source for which the resolver is being created.

$sel:requestMappingTemplate:CreateResolver', createResolver_requestMappingTemplate - The mapping template to be used 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 a Lambda data source. For all other data sources, VTL request and response mapping templates are required.

$sel:kind:CreateResolver', createResolver_kind - The resolver type.

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

$sel:cachingConfig:CreateResolver', createResolver_cachingConfig - The caching configuration for the resolver.

$sel:responseMappingTemplate:CreateResolver', createResolver_responseMappingTemplate - The mapping template to be used for responses from the data source.

$sel:syncConfig:CreateResolver', createResolver_syncConfig - The SyncConfig for a resolver attached to a versioned datasource.

$sel:pipelineConfig:CreateResolver', createResolver_pipelineConfig - The PipelineConfig.

$sel:apiId:CreateResolver', createResolver_apiId - The ID for the GraphQL API for which the resolver is being created.

$sel:typeName:CreateResolver', createResolver_typeName - The name of the Type.

$sel:fieldName:CreateResolver', createResolver_fieldName - The name of the field to attach the resolver to.

Request Lenses

createResolver_dataSourceName :: Lens' CreateResolver (Maybe Text) Source #

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

createResolver_requestMappingTemplate :: Lens' CreateResolver (Maybe Text) Source #

The mapping template to be used 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 a Lambda data source. For all other data sources, VTL request and response mapping templates are required.

createResolver_kind :: Lens' CreateResolver (Maybe ResolverKind) Source #

The resolver type.

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

createResolver_cachingConfig :: Lens' CreateResolver (Maybe CachingConfig) Source #

The caching configuration for the resolver.

createResolver_responseMappingTemplate :: Lens' CreateResolver (Maybe Text) Source #

The mapping template to be used for responses from the data source.

createResolver_syncConfig :: Lens' CreateResolver (Maybe SyncConfig) Source #

The SyncConfig for a resolver attached to a versioned datasource.

createResolver_pipelineConfig :: Lens' CreateResolver (Maybe PipelineConfig) Source #

The PipelineConfig.

createResolver_apiId :: Lens' CreateResolver Text Source #

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

createResolver_typeName :: Lens' CreateResolver Text Source #

The name of the Type.

createResolver_fieldName :: Lens' CreateResolver Text Source #

The name of the field to attach the resolver to.

Destructuring the Response

data CreateResolverResponse Source #

See: newCreateResolverResponse smart constructor.

Constructors

CreateResolverResponse'
Fields resolver :: Maybe Resolver The `Resolver` object. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateResolverResponse Source #
Instance details Defined in Amazonka.AppSync.CreateResolver Methods (==) :: CreateResolverResponse -> CreateResolverResponse -> Bool # (/=) :: CreateResolverResponse -> CreateResolverResponse -> Bool #
Read CreateResolverResponse Source #
Instance details Defined in Amazonka.AppSync.CreateResolver Methods readsPrec :: Int -> ReadS CreateResolverResponse # readList :: ReadS [CreateResolverResponse] # readPrec :: ReadPrec CreateResolverResponse # readListPrec :: ReadPrec [CreateResolverResponse] #
Show CreateResolverResponse Source #
Instance details Defined in Amazonka.AppSync.CreateResolver Methods showsPrec :: Int -> CreateResolverResponse -> ShowS # show :: CreateResolverResponse -> String # showList :: [CreateResolverResponse] -> ShowS #
Generic CreateResolverResponse Source #
Instance details Defined in Amazonka.AppSync.CreateResolver Associated Types type Rep CreateResolverResponse :: Type -> Type # Methods from :: CreateResolverResponse -> Rep CreateResolverResponse x # to :: Rep CreateResolverResponse x -> CreateResolverResponse #
NFData CreateResolverResponse Source #
Instance details Defined in Amazonka.AppSync.CreateResolver Methods rnf :: CreateResolverResponse -> () #
type Rep CreateResolverResponse Source #
Instance details Defined in Amazonka.AppSync.CreateResolver type Rep CreateResolverResponse = D1 ('MetaData "CreateResolverResponse" "Amazonka.AppSync.CreateResolver" "libZSservicesZSamazonka-appsyncZSamazonka-appsync" '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 Source #

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) Source #

The Resolver object.

createResolverResponse_httpStatus :: Lens' CreateResolverResponse Int Source #

The response's http status code.