Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AppSync.CreateGraphqlApi

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a GraphqlApi object.

Synopsis

data CreateGraphqlApi = CreateGraphqlApi' {
- additionalAuthenticationProviders :: Maybe [AdditionalAuthenticationProvider]
- lambdaAuthorizerConfig :: Maybe LambdaAuthorizerConfig
- logConfig :: Maybe LogConfig
- openIDConnectConfig :: Maybe OpenIDConnectConfig
- tags :: Maybe (HashMap Text Text)
- userPoolConfig :: Maybe UserPoolConfig
- xrayEnabled :: Maybe Bool
- name :: Text
- authenticationType :: AuthenticationType
}
newCreateGraphqlApi :: Text -> AuthenticationType -> CreateGraphqlApi
createGraphqlApi_additionalAuthenticationProviders :: Lens' CreateGraphqlApi (Maybe [AdditionalAuthenticationProvider])
createGraphqlApi_lambdaAuthorizerConfig :: Lens' CreateGraphqlApi (Maybe LambdaAuthorizerConfig)
createGraphqlApi_logConfig :: Lens' CreateGraphqlApi (Maybe LogConfig)
createGraphqlApi_openIDConnectConfig :: Lens' CreateGraphqlApi (Maybe OpenIDConnectConfig)
createGraphqlApi_tags :: Lens' CreateGraphqlApi (Maybe (HashMap Text Text))
createGraphqlApi_userPoolConfig :: Lens' CreateGraphqlApi (Maybe UserPoolConfig)
createGraphqlApi_xrayEnabled :: Lens' CreateGraphqlApi (Maybe Bool)
createGraphqlApi_name :: Lens' CreateGraphqlApi Text
createGraphqlApi_authenticationType :: Lens' CreateGraphqlApi AuthenticationType
data CreateGraphqlApiResponse = CreateGraphqlApiResponse' {
- graphqlApi :: Maybe GraphqlApi
- httpStatus :: Int
}
newCreateGraphqlApiResponse :: Int -> CreateGraphqlApiResponse
createGraphqlApiResponse_graphqlApi :: Lens' CreateGraphqlApiResponse (Maybe GraphqlApi)
createGraphqlApiResponse_httpStatus :: Lens' CreateGraphqlApiResponse Int

Creating a Request

data CreateGraphqlApi Source #

See: newCreateGraphqlApi smart constructor.

Constructors

CreateGraphqlApi'

Fields

additionalAuthenticationProviders :: Maybe [AdditionalAuthenticationProvider]
A list of additional authentication providers for the GraphqlApi API.
lambdaAuthorizerConfig :: Maybe LambdaAuthorizerConfig
Configuration for Lambda function authorization.
logConfig :: Maybe LogConfig
The Amazon CloudWatch Logs configuration.
openIDConnectConfig :: Maybe OpenIDConnectConfig
The OIDC configuration.
tags :: Maybe (HashMap Text Text)
A TagMap object.
userPoolConfig :: Maybe UserPoolConfig
The Amazon Cognito user pool configuration.
xrayEnabled :: Maybe Bool
A flag indicating whether to use X-Ray tracing for the GraphqlApi.
name :: Text
A user-supplied name for the GraphqlApi.
authenticationType :: AuthenticationType
The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

Instances

Instances details

ToJSON CreateGraphqlApi Source #
Instance details Defined in Amazonka.AppSync.CreateGraphqlApi Methods toJSON :: CreateGraphqlApi -> Value # toEncoding :: CreateGraphqlApi -> Encoding # toJSONList :: [CreateGraphqlApi] -> Value # toEncodingList :: [CreateGraphqlApi] -> Encoding #
ToHeaders CreateGraphqlApi Source #
Instance details Defined in Amazonka.AppSync.CreateGraphqlApi Methods toHeaders :: CreateGraphqlApi -> [Header] #
ToPath CreateGraphqlApi Source #
Instance details Defined in Amazonka.AppSync.CreateGraphqlApi Methods toPath :: CreateGraphqlApi -> ByteString #
ToQuery CreateGraphqlApi Source #
Instance details Defined in Amazonka.AppSync.CreateGraphqlApi Methods toQuery :: CreateGraphqlApi -> QueryString #
AWSRequest CreateGraphqlApi Source #
Instance details Defined in Amazonka.AppSync.CreateGraphqlApi Associated Types type AWSResponse CreateGraphqlApi # Methods request :: (Service -> Service) -> CreateGraphqlApi -> Request CreateGraphqlApi # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateGraphqlApi -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateGraphqlApi))) #
Generic CreateGraphqlApi Source #
Instance details Defined in Amazonka.AppSync.CreateGraphqlApi Associated Types type Rep CreateGraphqlApi :: Type -> Type # Methods from :: CreateGraphqlApi -> Rep CreateGraphqlApi x # to :: Rep CreateGraphqlApi x -> CreateGraphqlApi #
Read CreateGraphqlApi Source #
Instance details Defined in Amazonka.AppSync.CreateGraphqlApi Methods readsPrec :: Int -> ReadS CreateGraphqlApi # readList :: ReadS [CreateGraphqlApi] # readPrec :: ReadPrec CreateGraphqlApi # readListPrec :: ReadPrec [CreateGraphqlApi] #
Show CreateGraphqlApi Source #
Instance details Defined in Amazonka.AppSync.CreateGraphqlApi Methods showsPrec :: Int -> CreateGraphqlApi -> ShowS # show :: CreateGraphqlApi -> String # showList :: [CreateGraphqlApi] -> ShowS #
NFData CreateGraphqlApi Source #
Instance details Defined in Amazonka.AppSync.CreateGraphqlApi Methods rnf :: CreateGraphqlApi -> () #
Eq CreateGraphqlApi Source #
Instance details Defined in Amazonka.AppSync.CreateGraphqlApi Methods (==) :: CreateGraphqlApi -> CreateGraphqlApi -> Bool # (/=) :: CreateGraphqlApi -> CreateGraphqlApi -> Bool #
Hashable CreateGraphqlApi Source #
Instance details Defined in Amazonka.AppSync.CreateGraphqlApi Methods hashWithSalt :: Int -> CreateGraphqlApi -> Int # hash :: CreateGraphqlApi -> Int #
type AWSResponse CreateGraphqlApi Source #
Instance details Defined in Amazonka.AppSync.CreateGraphqlApi type AWSResponse CreateGraphqlApi = CreateGraphqlApiResponse
type Rep CreateGraphqlApi Source #
Instance details Defined in Amazonka.AppSync.CreateGraphqlApi type Rep CreateGraphqlApi = D1 ('MetaData "CreateGraphqlApi" "Amazonka.AppSync.CreateGraphqlApi" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" 'False) (C1 ('MetaCons "CreateGraphqlApi'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "additionalAuthenticationProviders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AdditionalAuthenticationProvider])) :: S1 ('MetaSel ('Just "lambdaAuthorizerConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LambdaAuthorizerConfig))) :: (S1 ('MetaSel ('Just "logConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LogConfig)) :: S1 ('MetaSel ('Just "openIDConnectConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OpenIDConnectConfig)))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "userPoolConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserPoolConfig))) :: (S1 ('MetaSel ('Just "xrayEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "authenticationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AuthenticationType))))))

newCreateGraphqlApi Source #

Arguments

:: Text	`CreateGraphqlApi`
-> AuthenticationType	`CreateGraphqlApi`
-> CreateGraphqlApi

Create a value of CreateGraphqlApi 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:

CreateGraphqlApi, createGraphqlApi_additionalAuthenticationProviders - A list of additional authentication providers for the GraphqlApi API.

CreateGraphqlApi, createGraphqlApi_lambdaAuthorizerConfig - Configuration for Lambda function authorization.

CreateGraphqlApi, createGraphqlApi_logConfig - The Amazon CloudWatch Logs configuration.

CreateGraphqlApi, createGraphqlApi_openIDConnectConfig - The OIDC configuration.

CreateGraphqlApi, createGraphqlApi_tags - A TagMap object.

CreateGraphqlApi, createGraphqlApi_userPoolConfig - The Amazon Cognito user pool configuration.

CreateGraphqlApi, createGraphqlApi_xrayEnabled - A flag indicating whether to use X-Ray tracing for the GraphqlApi.

CreateGraphqlApi, createGraphqlApi_name - A user-supplied name for the GraphqlApi.

CreateGraphqlApi, createGraphqlApi_authenticationType - The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

Request Lenses

createGraphqlApi_additionalAuthenticationProviders :: Lens' CreateGraphqlApi (Maybe [AdditionalAuthenticationProvider]) Source #

A list of additional authentication providers for the GraphqlApi API.

createGraphqlApi_lambdaAuthorizerConfig :: Lens' CreateGraphqlApi (Maybe LambdaAuthorizerConfig) Source #

Configuration for Lambda function authorization.

createGraphqlApi_logConfig :: Lens' CreateGraphqlApi (Maybe LogConfig) Source #

The Amazon CloudWatch Logs configuration.

createGraphqlApi_openIDConnectConfig :: Lens' CreateGraphqlApi (Maybe OpenIDConnectConfig) Source #

The OIDC configuration.

createGraphqlApi_tags :: Lens' CreateGraphqlApi (Maybe (HashMap Text Text)) Source #

A TagMap object.

createGraphqlApi_userPoolConfig :: Lens' CreateGraphqlApi (Maybe UserPoolConfig) Source #

The Amazon Cognito user pool configuration.

createGraphqlApi_xrayEnabled :: Lens' CreateGraphqlApi (Maybe Bool) Source #

A flag indicating whether to use X-Ray tracing for the GraphqlApi.

createGraphqlApi_name :: Lens' CreateGraphqlApi Text Source #

A user-supplied name for the GraphqlApi.

createGraphqlApi_authenticationType :: Lens' CreateGraphqlApi AuthenticationType Source #

The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

Destructuring the Response

data CreateGraphqlApiResponse Source #

See: newCreateGraphqlApiResponse smart constructor.

Constructors

CreateGraphqlApiResponse'
Fields graphqlApi :: Maybe GraphqlApi The `GraphqlApi`. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateGraphqlApiResponse Source #
Instance details Defined in Amazonka.AppSync.CreateGraphqlApi Associated Types type Rep CreateGraphqlApiResponse :: Type -> Type # Methods from :: CreateGraphqlApiResponse -> Rep CreateGraphqlApiResponse x # to :: Rep CreateGraphqlApiResponse x -> CreateGraphqlApiResponse #
Read CreateGraphqlApiResponse Source #
Instance details Defined in Amazonka.AppSync.CreateGraphqlApi Methods readsPrec :: Int -> ReadS CreateGraphqlApiResponse # readList :: ReadS [CreateGraphqlApiResponse] # readPrec :: ReadPrec CreateGraphqlApiResponse # readListPrec :: ReadPrec [CreateGraphqlApiResponse] #
Show CreateGraphqlApiResponse Source #
Instance details Defined in Amazonka.AppSync.CreateGraphqlApi Methods showsPrec :: Int -> CreateGraphqlApiResponse -> ShowS # show :: CreateGraphqlApiResponse -> String # showList :: [CreateGraphqlApiResponse] -> ShowS #
NFData CreateGraphqlApiResponse Source #
Instance details Defined in Amazonka.AppSync.CreateGraphqlApi Methods rnf :: CreateGraphqlApiResponse -> () #
Eq CreateGraphqlApiResponse Source #
Instance details Defined in Amazonka.AppSync.CreateGraphqlApi Methods (==) :: CreateGraphqlApiResponse -> CreateGraphqlApiResponse -> Bool # (/=) :: CreateGraphqlApiResponse -> CreateGraphqlApiResponse -> Bool #
type Rep CreateGraphqlApiResponse Source #
Instance details Defined in Amazonka.AppSync.CreateGraphqlApi type Rep CreateGraphqlApiResponse = D1 ('MetaData "CreateGraphqlApiResponse" "Amazonka.AppSync.CreateGraphqlApi" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" 'False) (C1 ('MetaCons "CreateGraphqlApiResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "graphqlApi") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GraphqlApi)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateGraphqlApiResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateGraphqlApiResponse'`
-> CreateGraphqlApiResponse

Create a value of CreateGraphqlApiResponse 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:graphqlApi:CreateGraphqlApiResponse', createGraphqlApiResponse_graphqlApi - The GraphqlApi.

$sel:httpStatus:CreateGraphqlApiResponse', createGraphqlApiResponse_httpStatus - The response's http status code.

Response Lenses

createGraphqlApiResponse_graphqlApi :: Lens' CreateGraphqlApiResponse (Maybe GraphqlApi) Source #

The GraphqlApi.

createGraphqlApiResponse_httpStatus :: Lens' CreateGraphqlApiResponse Int Source #

The response's http status code.