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.Types.GraphqlApi

Description

Synopsis

data GraphqlApi = GraphqlApi' {
- additionalAuthenticationProviders :: Maybe [AdditionalAuthenticationProvider]
- apiId :: Maybe Text
- arn :: Maybe Text
- authenticationType :: Maybe AuthenticationType
- lambdaAuthorizerConfig :: Maybe LambdaAuthorizerConfig
- logConfig :: Maybe LogConfig
- name :: Maybe Text
- openIDConnectConfig :: Maybe OpenIDConnectConfig
- tags :: Maybe (HashMap Text Text)
- uris :: Maybe (HashMap Text Text)
- userPoolConfig :: Maybe UserPoolConfig
- wafWebAclArn :: Maybe Text
- xrayEnabled :: Maybe Bool
}
newGraphqlApi :: GraphqlApi
graphqlApi_additionalAuthenticationProviders :: Lens' GraphqlApi (Maybe [AdditionalAuthenticationProvider])
graphqlApi_apiId :: Lens' GraphqlApi (Maybe Text)
graphqlApi_arn :: Lens' GraphqlApi (Maybe Text)
graphqlApi_authenticationType :: Lens' GraphqlApi (Maybe AuthenticationType)
graphqlApi_lambdaAuthorizerConfig :: Lens' GraphqlApi (Maybe LambdaAuthorizerConfig)
graphqlApi_logConfig :: Lens' GraphqlApi (Maybe LogConfig)
graphqlApi_name :: Lens' GraphqlApi (Maybe Text)
graphqlApi_openIDConnectConfig :: Lens' GraphqlApi (Maybe OpenIDConnectConfig)
graphqlApi_tags :: Lens' GraphqlApi (Maybe (HashMap Text Text))
graphqlApi_uris :: Lens' GraphqlApi (Maybe (HashMap Text Text))
graphqlApi_userPoolConfig :: Lens' GraphqlApi (Maybe UserPoolConfig)
graphqlApi_wafWebAclArn :: Lens' GraphqlApi (Maybe Text)
graphqlApi_xrayEnabled :: Lens' GraphqlApi (Maybe Bool)

Documentation

data GraphqlApi Source #

Describes a GraphQL API.

See: newGraphqlApi smart constructor.

Constructors

GraphqlApi'

Fields

additionalAuthenticationProviders :: Maybe [AdditionalAuthenticationProvider]
A list of additional authentication providers for the GraphqlApi API.
apiId :: Maybe Text
The API ID.
arn :: Maybe Text
The Amazon Resource Name (ARN).
authenticationType :: Maybe AuthenticationType
The authentication type.
lambdaAuthorizerConfig :: Maybe LambdaAuthorizerConfig
Configuration for Lambda function authorization.
logConfig :: Maybe LogConfig
The Amazon CloudWatch Logs configuration.
name :: Maybe Text
The API name.
openIDConnectConfig :: Maybe OpenIDConnectConfig
The OpenID Connect configuration.
tags :: Maybe (HashMap Text Text)
The tags.
uris :: Maybe (HashMap Text Text)
The URIs.
userPoolConfig :: Maybe UserPoolConfig
The Amazon Cognito user pool configuration.
wafWebAclArn :: Maybe Text
The ARN of the WAF access control list (ACL) associated with this GraphqlApi, if one exists.
xrayEnabled :: Maybe Bool
A flag indicating whether to use X-Ray tracing for this GraphqlApi.

Instances

Instances details

FromJSON GraphqlApi Source #
Instance details Defined in Amazonka.AppSync.Types.GraphqlApi Methods parseJSON :: Value -> Parser GraphqlApi # parseJSONList :: Value -> Parser [GraphqlApi] #
Generic GraphqlApi Source #
Instance details Defined in Amazonka.AppSync.Types.GraphqlApi Associated Types type Rep GraphqlApi :: Type -> Type # Methods from :: GraphqlApi -> Rep GraphqlApi x # to :: Rep GraphqlApi x -> GraphqlApi #
Read GraphqlApi Source #
Instance details Defined in Amazonka.AppSync.Types.GraphqlApi Methods readsPrec :: Int -> ReadS GraphqlApi # readList :: ReadS [GraphqlApi] # readPrec :: ReadPrec GraphqlApi # readListPrec :: ReadPrec [GraphqlApi] #
Show GraphqlApi Source #
Instance details Defined in Amazonka.AppSync.Types.GraphqlApi Methods showsPrec :: Int -> GraphqlApi -> ShowS # show :: GraphqlApi -> String # showList :: [GraphqlApi] -> ShowS #
NFData GraphqlApi Source #
Instance details Defined in Amazonka.AppSync.Types.GraphqlApi Methods rnf :: GraphqlApi -> () #
Eq GraphqlApi Source #
Instance details Defined in Amazonka.AppSync.Types.GraphqlApi Methods (==) :: GraphqlApi -> GraphqlApi -> Bool # (/=) :: GraphqlApi -> GraphqlApi -> Bool #
Hashable GraphqlApi Source #
Instance details Defined in Amazonka.AppSync.Types.GraphqlApi Methods hashWithSalt :: Int -> GraphqlApi -> Int # hash :: GraphqlApi -> Int #
type Rep GraphqlApi Source #
Instance details Defined in Amazonka.AppSync.Types.GraphqlApi type Rep GraphqlApi = D1 ('MetaData "GraphqlApi" "Amazonka.AppSync.Types.GraphqlApi" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" 'False) (C1 ('MetaCons "GraphqlApi'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "additionalAuthenticationProviders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AdditionalAuthenticationProvider])) :: (S1 ('MetaSel ('Just "apiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "authenticationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthenticationType)) :: (S1 ('MetaSel ('Just "lambdaAuthorizerConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LambdaAuthorizerConfig)) :: S1 ('MetaSel ('Just "logConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LogConfig))))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (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 "uris") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "userPoolConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserPoolConfig))) :: (S1 ('MetaSel ('Just "wafWebAclArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "xrayEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))))

newGraphqlApi :: GraphqlApi Source #

Create a value of GraphqlApi 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:additionalAuthenticationProviders:GraphqlApi', graphqlApi_additionalAuthenticationProviders - A list of additional authentication providers for the GraphqlApi API.

$sel:apiId:GraphqlApi', graphqlApi_apiId - The API ID.

$sel:arn:GraphqlApi', graphqlApi_arn - The Amazon Resource Name (ARN).

GraphqlApi, graphqlApi_authenticationType - The authentication type.

GraphqlApi, graphqlApi_lambdaAuthorizerConfig - Configuration for Lambda function authorization.

$sel:logConfig:GraphqlApi', graphqlApi_logConfig - The Amazon CloudWatch Logs configuration.

$sel:name:GraphqlApi', graphqlApi_name - The API name.

GraphqlApi, graphqlApi_openIDConnectConfig - The OpenID Connect configuration.

$sel:tags:GraphqlApi', graphqlApi_tags - The tags.

$sel:uris:GraphqlApi', graphqlApi_uris - The URIs.

GraphqlApi, graphqlApi_userPoolConfig - The Amazon Cognito user pool configuration.

$sel:wafWebAclArn:GraphqlApi', graphqlApi_wafWebAclArn - The ARN of the WAF access control list (ACL) associated with this GraphqlApi, if one exists.

$sel:xrayEnabled:GraphqlApi', graphqlApi_xrayEnabled - A flag indicating whether to use X-Ray tracing for this GraphqlApi.

graphqlApi_additionalAuthenticationProviders :: Lens' GraphqlApi (Maybe [AdditionalAuthenticationProvider]) Source #

A list of additional authentication providers for the GraphqlApi API.

graphqlApi_apiId :: Lens' GraphqlApi (Maybe Text) Source #

The API ID.

graphqlApi_arn :: Lens' GraphqlApi (Maybe Text) Source #

The Amazon Resource Name (ARN).

graphqlApi_authenticationType :: Lens' GraphqlApi (Maybe AuthenticationType) Source #

The authentication type.

graphqlApi_lambdaAuthorizerConfig :: Lens' GraphqlApi (Maybe LambdaAuthorizerConfig) Source #

Configuration for Lambda function authorization.

graphqlApi_logConfig :: Lens' GraphqlApi (Maybe LogConfig) Source #