| 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
Contents
- Service Configuration
- Errors
- ApiCacheStatus
- ApiCacheType
- ApiCachingBehavior
- AssociationStatus
- AuthenticationType
- AuthorizationType
- ConflictDetectionType
- ConflictHandlerType
- DataSourceType
- DefaultAction
- FieldLogLevel
- OutputType
- RelationalDatabaseSourceType
- ResolverKind
- RuntimeName
- SchemaStatus
- TypeDefinitionFormat
- AdditionalAuthenticationProvider
- ApiAssociation
- ApiCache
- ApiKey
- AppSyncRuntime
- AuthorizationConfig
- AwsIamConfig
- CachingConfig
- CodeError
- CodeErrorLocation
- CognitoUserPoolConfig
- DataSource
- DeltaSyncConfig
- DomainNameConfig
- DynamodbDataSourceConfig
- ElasticsearchDataSourceConfig
- ErrorDetail
- EvaluateCodeErrorDetail
- FunctionConfiguration
- GraphqlApi
- HttpDataSourceConfig
- LambdaAuthorizerConfig
- LambdaConflictHandlerConfig
- LambdaDataSourceConfig
- LogConfig
- OpenIDConnectConfig
- OpenSearchServiceDataSourceConfig
- PipelineConfig
- RdsHttpEndpointConfig
- RelationalDatabaseDataSourceConfig
- Resolver
- SyncConfig
- Type
- UserPoolConfig
Description
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ApiKeyLimitExceededException :: AsError a => Fold a ServiceError
- _ApiKeyValidityOutOfBoundsException :: AsError a => Fold a ServiceError
- _ApiLimitExceededException :: AsError a => Fold a ServiceError
- _BadRequestException :: AsError a => Fold a ServiceError
- _ConcurrentModificationException :: AsError a => Fold a ServiceError
- _GraphQLSchemaException :: AsError a => Fold a ServiceError
- _InternalFailureException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _NotFoundException :: AsError a => Fold a ServiceError
- _UnauthorizedException :: AsError a => Fold a ServiceError
- newtype ApiCacheStatus where
- ApiCacheStatus' { }
- pattern ApiCacheStatus_AVAILABLE :: ApiCacheStatus
- pattern ApiCacheStatus_CREATING :: ApiCacheStatus
- pattern ApiCacheStatus_DELETING :: ApiCacheStatus
- pattern ApiCacheStatus_FAILED :: ApiCacheStatus
- pattern ApiCacheStatus_MODIFYING :: ApiCacheStatus
- newtype ApiCacheType where
- ApiCacheType' { }
- pattern ApiCacheType_LARGE :: ApiCacheType
- pattern ApiCacheType_LARGE_12X :: ApiCacheType
- pattern ApiCacheType_LARGE_2X :: ApiCacheType
- pattern ApiCacheType_LARGE_4X :: ApiCacheType
- pattern ApiCacheType_LARGE_8X :: ApiCacheType
- pattern ApiCacheType_MEDIUM :: ApiCacheType
- pattern ApiCacheType_R4_2XLARGE :: ApiCacheType
- pattern ApiCacheType_R4_4XLARGE :: ApiCacheType
- pattern ApiCacheType_R4_8XLARGE :: ApiCacheType
- pattern ApiCacheType_R4_LARGE :: ApiCacheType
- pattern ApiCacheType_R4_XLARGE :: ApiCacheType
- pattern ApiCacheType_SMALL :: ApiCacheType
- pattern ApiCacheType_T2_MEDIUM :: ApiCacheType
- pattern ApiCacheType_T2_SMALL :: ApiCacheType
- pattern ApiCacheType_XLARGE :: ApiCacheType
- newtype ApiCachingBehavior where
- newtype AssociationStatus where
- AssociationStatus' { }
- pattern AssociationStatus_FAILED :: AssociationStatus
- pattern AssociationStatus_PROCESSING :: AssociationStatus
- pattern AssociationStatus_SUCCESS :: AssociationStatus
- newtype AuthenticationType where
- AuthenticationType' { }
- pattern AuthenticationType_AMAZON_COGNITO_USER_POOLS :: AuthenticationType
- pattern AuthenticationType_API_KEY :: AuthenticationType
- pattern AuthenticationType_AWS_IAM :: AuthenticationType
- pattern AuthenticationType_AWS_LAMBDA :: AuthenticationType
- pattern AuthenticationType_OPENID_CONNECT :: AuthenticationType
- newtype AuthorizationType where
- newtype ConflictDetectionType where
- newtype ConflictHandlerType where
- newtype DataSourceType where
- DataSourceType' { }
- pattern DataSourceType_AMAZON_DYNAMODB :: DataSourceType
- pattern DataSourceType_AMAZON_ELASTICSEARCH :: DataSourceType
- pattern DataSourceType_AMAZON_OPENSEARCH_SERVICE :: DataSourceType
- pattern DataSourceType_AWS_LAMBDA :: DataSourceType
- pattern DataSourceType_HTTP :: DataSourceType
- pattern DataSourceType_NONE :: DataSourceType
- pattern DataSourceType_RELATIONAL_DATABASE :: DataSourceType
- newtype DefaultAction where
- DefaultAction' { }
- pattern DefaultAction_ALLOW :: DefaultAction
- pattern DefaultAction_DENY :: DefaultAction
- newtype FieldLogLevel where
- FieldLogLevel' { }
- pattern FieldLogLevel_ALL :: FieldLogLevel
- pattern FieldLogLevel_ERROR :: FieldLogLevel
- pattern FieldLogLevel_NONE :: FieldLogLevel
- newtype OutputType where
- OutputType' { }
- pattern OutputType_JSON :: OutputType
- pattern OutputType_SDL :: OutputType
- newtype RelationalDatabaseSourceType where
- newtype ResolverKind where
- ResolverKind' { }
- pattern ResolverKind_PIPELINE :: ResolverKind
- pattern ResolverKind_UNIT :: ResolverKind
- newtype RuntimeName where
- RuntimeName' { }
- pattern RuntimeName_APPSYNC_JS :: RuntimeName
- newtype SchemaStatus where
- SchemaStatus' { }
- pattern SchemaStatus_ACTIVE :: SchemaStatus
- pattern SchemaStatus_DELETING :: SchemaStatus
- pattern SchemaStatus_FAILED :: SchemaStatus
- pattern SchemaStatus_NOT_APPLICABLE :: SchemaStatus
- pattern SchemaStatus_PROCESSING :: SchemaStatus
- pattern SchemaStatus_SUCCESS :: SchemaStatus
- newtype TypeDefinitionFormat where
- data AdditionalAuthenticationProvider = AdditionalAuthenticationProvider' {}
- newAdditionalAuthenticationProvider :: AdditionalAuthenticationProvider
- additionalAuthenticationProvider_authenticationType :: Lens' AdditionalAuthenticationProvider (Maybe AuthenticationType)
- additionalAuthenticationProvider_lambdaAuthorizerConfig :: Lens' AdditionalAuthenticationProvider (Maybe LambdaAuthorizerConfig)
- additionalAuthenticationProvider_openIDConnectConfig :: Lens' AdditionalAuthenticationProvider (Maybe OpenIDConnectConfig)
- additionalAuthenticationProvider_userPoolConfig :: Lens' AdditionalAuthenticationProvider (Maybe CognitoUserPoolConfig)
- data ApiAssociation = ApiAssociation' {}
- newApiAssociation :: ApiAssociation
- apiAssociation_apiId :: Lens' ApiAssociation (Maybe Text)
- apiAssociation_associationStatus :: Lens' ApiAssociation (Maybe AssociationStatus)
- apiAssociation_deploymentDetail :: Lens' ApiAssociation (Maybe Text)
- apiAssociation_domainName :: Lens' ApiAssociation (Maybe Text)
- data ApiCache = ApiCache' {}
- newApiCache :: ApiCache
- apiCache_apiCachingBehavior :: Lens' ApiCache (Maybe ApiCachingBehavior)
- apiCache_atRestEncryptionEnabled :: Lens' ApiCache (Maybe Bool)
- apiCache_status :: Lens' ApiCache (Maybe ApiCacheStatus)
- apiCache_transitEncryptionEnabled :: Lens' ApiCache (Maybe Bool)
- apiCache_ttl :: Lens' ApiCache (Maybe Integer)
- apiCache_type :: Lens' ApiCache (Maybe ApiCacheType)
- data ApiKey = ApiKey' {}
- newApiKey :: ApiKey
- apiKey_deletes :: Lens' ApiKey (Maybe Integer)
- apiKey_description :: Lens' ApiKey (Maybe Text)
- apiKey_expires :: Lens' ApiKey (Maybe Integer)
- apiKey_id :: Lens' ApiKey (Maybe Text)
- data AppSyncRuntime = AppSyncRuntime' {}
- newAppSyncRuntime :: RuntimeName -> Text -> AppSyncRuntime
- appSyncRuntime_name :: Lens' AppSyncRuntime RuntimeName
- appSyncRuntime_runtimeVersion :: Lens' AppSyncRuntime Text
- data AuthorizationConfig = AuthorizationConfig' {}
- newAuthorizationConfig :: AuthorizationType -> AuthorizationConfig
- authorizationConfig_awsIamConfig :: Lens' AuthorizationConfig (Maybe AwsIamConfig)
- authorizationConfig_authorizationType :: Lens' AuthorizationConfig AuthorizationType
- data AwsIamConfig = AwsIamConfig' {}
- newAwsIamConfig :: AwsIamConfig
- awsIamConfig_signingRegion :: Lens' AwsIamConfig (Maybe Text)
- awsIamConfig_signingServiceName :: Lens' AwsIamConfig (Maybe Text)
- data CachingConfig = CachingConfig' {
- cachingKeys :: Maybe [Text]
- ttl :: Integer
- newCachingConfig :: Integer -> CachingConfig
- cachingConfig_cachingKeys :: Lens' CachingConfig (Maybe [Text])
- cachingConfig_ttl :: Lens' CachingConfig Integer
- data CodeError = CodeError' {}
- newCodeError :: CodeError
- codeError_errorType :: Lens' CodeError (Maybe Text)
- codeError_location :: Lens' CodeError (Maybe CodeErrorLocation)
- codeError_value :: Lens' CodeError (Maybe Text)
- data CodeErrorLocation = CodeErrorLocation' {}
- newCodeErrorLocation :: CodeErrorLocation
- codeErrorLocation_column :: Lens' CodeErrorLocation (Maybe Int)
- codeErrorLocation_line :: Lens' CodeErrorLocation (Maybe Int)
- codeErrorLocation_span :: Lens' CodeErrorLocation (Maybe Int)
- data CognitoUserPoolConfig = CognitoUserPoolConfig' {
- appIdClientRegex :: Maybe Text
- userPoolId :: Text
- awsRegion :: Text
- newCognitoUserPoolConfig :: Text -> Text -> CognitoUserPoolConfig
- cognitoUserPoolConfig_appIdClientRegex :: Lens' CognitoUserPoolConfig (Maybe Text)
- cognitoUserPoolConfig_userPoolId :: Lens' CognitoUserPoolConfig Text
- cognitoUserPoolConfig_awsRegion :: Lens' CognitoUserPoolConfig Text
- data DataSource = DataSource' {
- dataSourceArn :: Maybe Text
- description :: Maybe Text
- dynamodbConfig :: Maybe DynamodbDataSourceConfig
- elasticsearchConfig :: Maybe ElasticsearchDataSourceConfig
- httpConfig :: Maybe HttpDataSourceConfig
- lambdaConfig :: Maybe LambdaDataSourceConfig
- name :: Maybe Text
- openSearchServiceConfig :: Maybe OpenSearchServiceDataSourceConfig
- relationalDatabaseConfig :: Maybe RelationalDatabaseDataSourceConfig
- serviceRoleArn :: Maybe Text
- type' :: Maybe DataSourceType
- newDataSource :: DataSource
- dataSource_dataSourceArn :: Lens' DataSource (Maybe Text)
- dataSource_description :: Lens' DataSource (Maybe Text)
- dataSource_dynamodbConfig :: Lens' DataSource (Maybe DynamodbDataSourceConfig)
- dataSource_elasticsearchConfig :: Lens' DataSource (Maybe ElasticsearchDataSourceConfig)
- dataSource_httpConfig :: Lens' DataSource (Maybe HttpDataSourceConfig)
- dataSource_lambdaConfig :: Lens' DataSource (Maybe LambdaDataSourceConfig)
- dataSource_name :: Lens' DataSource (Maybe Text)
- dataSource_openSearchServiceConfig :: Lens' DataSource (Maybe OpenSearchServiceDataSourceConfig)
- dataSource_relationalDatabaseConfig :: Lens' DataSource (Maybe RelationalDatabaseDataSourceConfig)
- dataSource_serviceRoleArn :: Lens' DataSource (Maybe Text)
- dataSource_type :: Lens' DataSource (Maybe DataSourceType)
- data DeltaSyncConfig = DeltaSyncConfig' {}
- newDeltaSyncConfig :: DeltaSyncConfig
- deltaSyncConfig_baseTableTTL :: Lens' DeltaSyncConfig (Maybe Integer)
- deltaSyncConfig_deltaSyncTableName :: Lens' DeltaSyncConfig (Maybe Text)
- deltaSyncConfig_deltaSyncTableTTL :: Lens' DeltaSyncConfig (Maybe Integer)
- data DomainNameConfig = DomainNameConfig' {}
- newDomainNameConfig :: DomainNameConfig
- domainNameConfig_appsyncDomainName :: Lens' DomainNameConfig (Maybe Text)
- domainNameConfig_certificateArn :: Lens' DomainNameConfig (Maybe Text)
- domainNameConfig_description :: Lens' DomainNameConfig (Maybe Text)
- domainNameConfig_domainName :: Lens' DomainNameConfig (Maybe Text)
- domainNameConfig_hostedZoneId :: Lens' DomainNameConfig (Maybe Text)
- data DynamodbDataSourceConfig = DynamodbDataSourceConfig' {}
- newDynamodbDataSourceConfig :: Text -> Text -> DynamodbDataSourceConfig
- dynamodbDataSourceConfig_deltaSyncConfig :: Lens' DynamodbDataSourceConfig (Maybe DeltaSyncConfig)
- dynamodbDataSourceConfig_useCallerCredentials :: Lens' DynamodbDataSourceConfig (Maybe Bool)
- dynamodbDataSourceConfig_versioned :: Lens' DynamodbDataSourceConfig (Maybe Bool)
- dynamodbDataSourceConfig_tableName :: Lens' DynamodbDataSourceConfig Text
- dynamodbDataSourceConfig_awsRegion :: Lens' DynamodbDataSourceConfig Text
- data ElasticsearchDataSourceConfig = ElasticsearchDataSourceConfig' {}
- newElasticsearchDataSourceConfig :: Text -> Text -> ElasticsearchDataSourceConfig
- elasticsearchDataSourceConfig_endpoint :: Lens' ElasticsearchDataSourceConfig Text
- elasticsearchDataSourceConfig_awsRegion :: Lens' ElasticsearchDataSourceConfig Text
- data ErrorDetail = ErrorDetail' {}
- newErrorDetail :: ErrorDetail
- errorDetail_message :: Lens' ErrorDetail (Maybe Text)
- data EvaluateCodeErrorDetail = EvaluateCodeErrorDetail' {}
- newEvaluateCodeErrorDetail :: EvaluateCodeErrorDetail
- evaluateCodeErrorDetail_codeErrors :: Lens' EvaluateCodeErrorDetail (Maybe [CodeError])
- evaluateCodeErrorDetail_message :: Lens' EvaluateCodeErrorDetail (Maybe Text)
- data FunctionConfiguration = FunctionConfiguration' {
- code :: Maybe Text
- dataSourceName :: Maybe Text
- description :: Maybe Text
- functionArn :: Maybe Text
- functionId :: Maybe Text
- functionVersion :: Maybe Text
- maxBatchSize :: Maybe Natural
- name :: Maybe Text
- requestMappingTemplate :: Maybe Text
- responseMappingTemplate :: Maybe Text
- runtime :: Maybe AppSyncRuntime
- syncConfig :: Maybe SyncConfig
- newFunctionConfiguration :: FunctionConfiguration
- functionConfiguration_code :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_dataSourceName :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_description :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_functionArn :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_functionId :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_functionVersion :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_maxBatchSize :: Lens' FunctionConfiguration (Maybe Natural)
- functionConfiguration_name :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_requestMappingTemplate :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_responseMappingTemplate :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_runtime :: Lens' FunctionConfiguration (Maybe AppSyncRuntime)
- functionConfiguration_syncConfig :: Lens' FunctionConfiguration (Maybe SyncConfig)
- 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)
- data HttpDataSourceConfig = HttpDataSourceConfig' {}
- newHttpDataSourceConfig :: HttpDataSourceConfig
- httpDataSourceConfig_authorizationConfig :: Lens' HttpDataSourceConfig (Maybe AuthorizationConfig)
- httpDataSourceConfig_endpoint :: Lens' HttpDataSourceConfig (Maybe Text)
- data LambdaAuthorizerConfig = LambdaAuthorizerConfig' {}
- newLambdaAuthorizerConfig :: Text -> LambdaAuthorizerConfig
- lambdaAuthorizerConfig_authorizerResultTtlInSeconds :: Lens' LambdaAuthorizerConfig (Maybe Natural)
- lambdaAuthorizerConfig_identityValidationExpression :: Lens' LambdaAuthorizerConfig (Maybe Text)
- lambdaAuthorizerConfig_authorizerUri :: Lens' LambdaAuthorizerConfig Text
- data LambdaConflictHandlerConfig = LambdaConflictHandlerConfig' {}
- newLambdaConflictHandlerConfig :: LambdaConflictHandlerConfig
- lambdaConflictHandlerConfig_lambdaConflictHandlerArn :: Lens' LambdaConflictHandlerConfig (Maybe Text)
- data LambdaDataSourceConfig = LambdaDataSourceConfig' {}
- newLambdaDataSourceConfig :: Text -> LambdaDataSourceConfig
- lambdaDataSourceConfig_lambdaFunctionArn :: Lens' LambdaDataSourceConfig Text
- data LogConfig = LogConfig' {}
- newLogConfig :: FieldLogLevel -> Text -> LogConfig
- logConfig_excludeVerboseContent :: Lens' LogConfig (Maybe Bool)
- logConfig_fieldLogLevel :: Lens' LogConfig FieldLogLevel
- logConfig_cloudWatchLogsRoleArn :: Lens' LogConfig Text
- data OpenIDConnectConfig = OpenIDConnectConfig' {}
- newOpenIDConnectConfig :: Text -> OpenIDConnectConfig
- openIDConnectConfig_authTTL :: Lens' OpenIDConnectConfig (Maybe Integer)
- openIDConnectConfig_clientId :: Lens' OpenIDConnectConfig (Maybe Text)
- openIDConnectConfig_iatTTL :: Lens' OpenIDConnectConfig (Maybe Integer)
- openIDConnectConfig_issuer :: Lens' OpenIDConnectConfig Text
- data OpenSearchServiceDataSourceConfig = OpenSearchServiceDataSourceConfig' {}
- newOpenSearchServiceDataSourceConfig :: Text -> Text -> OpenSearchServiceDataSourceConfig
- openSearchServiceDataSourceConfig_endpoint :: Lens' OpenSearchServiceDataSourceConfig Text
- openSearchServiceDataSourceConfig_awsRegion :: Lens' OpenSearchServiceDataSourceConfig Text
- data PipelineConfig = PipelineConfig' {}
- newPipelineConfig :: PipelineConfig
- pipelineConfig_functions :: Lens' PipelineConfig (Maybe [Text])
- data RdsHttpEndpointConfig = RdsHttpEndpointConfig' {}
- newRdsHttpEndpointConfig :: RdsHttpEndpointConfig
- rdsHttpEndpointConfig_awsRegion :: Lens' RdsHttpEndpointConfig (Maybe Text)
- rdsHttpEndpointConfig_awsSecretStoreArn :: Lens' RdsHttpEndpointConfig (Maybe Text)
- rdsHttpEndpointConfig_databaseName :: Lens' RdsHttpEndpointConfig (Maybe Text)
- rdsHttpEndpointConfig_dbClusterIdentifier :: Lens' RdsHttpEndpointConfig (Maybe Text)
- rdsHttpEndpointConfig_schema :: Lens' RdsHttpEndpointConfig (Maybe Text)
- data RelationalDatabaseDataSourceConfig = RelationalDatabaseDataSourceConfig' {}
- newRelationalDatabaseDataSourceConfig :: RelationalDatabaseDataSourceConfig
- relationalDatabaseDataSourceConfig_rdsHttpEndpointConfig :: Lens' RelationalDatabaseDataSourceConfig (Maybe RdsHttpEndpointConfig)
- relationalDatabaseDataSourceConfig_relationalDatabaseSourceType :: Lens' RelationalDatabaseDataSourceConfig (Maybe RelationalDatabaseSourceType)
- data Resolver = Resolver' {
- cachingConfig :: Maybe CachingConfig
- code :: Maybe Text
- dataSourceName :: Maybe Text
- fieldName :: Maybe Text
- kind :: Maybe ResolverKind
- maxBatchSize :: Maybe Natural
- pipelineConfig :: Maybe PipelineConfig
- requestMappingTemplate :: Maybe Text
- resolverArn :: Maybe Text
- responseMappingTemplate :: Maybe Text
- runtime :: Maybe AppSyncRuntime
- syncConfig :: Maybe SyncConfig
- typeName :: Maybe Text
- newResolver :: Resolver
- resolver_cachingConfig :: Lens' Resolver (Maybe CachingConfig)
- resolver_code :: Lens' Resolver (Maybe Text)
- resolver_dataSourceName :: Lens' Resolver (Maybe Text)
- resolver_fieldName :: Lens' Resolver (Maybe Text)
- resolver_kind :: Lens' Resolver (Maybe ResolverKind)
- resolver_maxBatchSize :: Lens' Resolver (Maybe Natural)
- resolver_pipelineConfig :: Lens' Resolver (Maybe PipelineConfig)
- resolver_requestMappingTemplate :: Lens' Resolver (Maybe Text)
- resolver_resolverArn :: Lens' Resolver (Maybe Text)
- resolver_responseMappingTemplate :: Lens' Resolver (Maybe Text)
- resolver_runtime :: Lens' Resolver (Maybe AppSyncRuntime)
- resolver_syncConfig :: Lens' Resolver (Maybe SyncConfig)
- resolver_typeName :: Lens' Resolver (Maybe Text)
- data SyncConfig = SyncConfig' {}
- newSyncConfig :: SyncConfig
- syncConfig_conflictDetection :: Lens' SyncConfig (Maybe ConflictDetectionType)
- syncConfig_conflictHandler :: Lens' SyncConfig (Maybe ConflictHandlerType)
- syncConfig_lambdaConflictHandlerConfig :: Lens' SyncConfig (Maybe LambdaConflictHandlerConfig)
- data Type = Type' {
- arn :: Maybe Text
- definition :: Maybe Text
- description :: Maybe Text
- format :: Maybe TypeDefinitionFormat
- name :: Maybe Text
- newType :: Type
- type_arn :: Lens' Type (Maybe Text)
- type_definition :: Lens' Type (Maybe Text)
- type_description :: Lens' Type (Maybe Text)
- type_format :: Lens' Type (Maybe TypeDefinitionFormat)
- type_name :: Lens' Type (Maybe Text)
- data UserPoolConfig = UserPoolConfig' {}
- newUserPoolConfig :: Text -> Text -> DefaultAction -> UserPoolConfig
- userPoolConfig_appIdClientRegex :: Lens' UserPoolConfig (Maybe Text)
- userPoolConfig_userPoolId :: Lens' UserPoolConfig Text
- userPoolConfig_awsRegion :: Lens' UserPoolConfig Text
- userPoolConfig_defaultAction :: Lens' UserPoolConfig DefaultAction
Service Configuration
defaultService :: Service Source #
API version 2017-07-25 of the Amazon AppSync SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You don't have access to perform this operation on this resource.
_ApiKeyLimitExceededException :: AsError a => Fold a ServiceError Source #
The API key exceeded a limit. Try your request again.
_ApiKeyValidityOutOfBoundsException :: AsError a => Fold a ServiceError Source #
The API key expiration must be set to a value between 1 and 365 days
from creation (for CreateApiKey) or from update (for UpdateApiKey).
_ApiLimitExceededException :: AsError a => Fold a ServiceError Source #
The GraphQL API exceeded a limit. Try your request again.
_BadRequestException :: AsError a => Fold a ServiceError Source #
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.
_ConcurrentModificationException :: AsError a => Fold a ServiceError Source #
Another modification is in progress at this time and it must complete before you can make your change.
_GraphQLSchemaException :: AsError a => Fold a ServiceError Source #
The GraphQL schema is not valid.
_InternalFailureException :: AsError a => Fold a ServiceError Source #
An internal AppSync error occurred. Try your request again.
_LimitExceededException :: AsError a => Fold a ServiceError Source #
The request exceeded a limit. Try your request again.
_NotFoundException :: AsError a => Fold a ServiceError Source #
The resource specified in the request was not found. Check the resource, and then try again.
_UnauthorizedException :: AsError a => Fold a ServiceError Source #
You aren't authorized to perform this operation.
ApiCacheStatus
newtype ApiCacheStatus Source #
Constructors
| ApiCacheStatus' | |
Fields | |
Bundled Patterns
| pattern ApiCacheStatus_AVAILABLE :: ApiCacheStatus | |
| pattern ApiCacheStatus_CREATING :: ApiCacheStatus | |
| pattern ApiCacheStatus_DELETING :: ApiCacheStatus | |
| pattern ApiCacheStatus_FAILED :: ApiCacheStatus | |
| pattern ApiCacheStatus_MODIFYING :: ApiCacheStatus |
Instances
ApiCacheType
newtype ApiCacheType Source #
Constructors
| ApiCacheType' | |
Fields | |
Bundled Patterns
| pattern ApiCacheType_LARGE :: ApiCacheType | |
| pattern ApiCacheType_LARGE_12X :: ApiCacheType | |
| pattern ApiCacheType_LARGE_2X :: ApiCacheType | |
| pattern ApiCacheType_LARGE_4X :: ApiCacheType | |
| pattern ApiCacheType_LARGE_8X :: ApiCacheType | |
| pattern ApiCacheType_MEDIUM :: ApiCacheType | |
| pattern ApiCacheType_R4_2XLARGE :: ApiCacheType | |
| pattern ApiCacheType_R4_4XLARGE :: ApiCacheType | |
| pattern ApiCacheType_R4_8XLARGE :: ApiCacheType | |
| pattern ApiCacheType_R4_LARGE :: ApiCacheType | |
| pattern ApiCacheType_R4_XLARGE :: ApiCacheType | |
| pattern ApiCacheType_SMALL :: ApiCacheType | |
| pattern ApiCacheType_T2_MEDIUM :: ApiCacheType | |
| pattern ApiCacheType_T2_SMALL :: ApiCacheType | |
| pattern ApiCacheType_XLARGE :: ApiCacheType |
Instances
ApiCachingBehavior
newtype ApiCachingBehavior Source #
Constructors
| ApiCachingBehavior' | |
Fields | |
Bundled Patterns
| pattern ApiCachingBehavior_FULL_REQUEST_CACHING :: ApiCachingBehavior | |
| pattern ApiCachingBehavior_PER_RESOLVER_CACHING :: ApiCachingBehavior |
Instances
AssociationStatus
newtype AssociationStatus Source #
Constructors
| AssociationStatus' | |
Fields | |
Bundled Patterns
| pattern AssociationStatus_FAILED :: AssociationStatus | |
| pattern AssociationStatus_PROCESSING :: AssociationStatus | |
| pattern AssociationStatus_SUCCESS :: AssociationStatus |
Instances
AuthenticationType
newtype AuthenticationType Source #
Constructors
| AuthenticationType' | |
Fields | |
Bundled Patterns
| pattern AuthenticationType_AMAZON_COGNITO_USER_POOLS :: AuthenticationType | |
| pattern AuthenticationType_API_KEY :: AuthenticationType | |
| pattern AuthenticationType_AWS_IAM :: AuthenticationType | |
| pattern AuthenticationType_AWS_LAMBDA :: AuthenticationType | |
| pattern AuthenticationType_OPENID_CONNECT :: AuthenticationType |
Instances
AuthorizationType
newtype AuthorizationType Source #
Constructors
| AuthorizationType' | |
Fields | |
Bundled Patterns
| pattern AuthorizationType_AWS_IAM :: AuthorizationType |
Instances
ConflictDetectionType
newtype ConflictDetectionType Source #
Constructors
| ConflictDetectionType' | |
Fields | |
Bundled Patterns
| pattern ConflictDetectionType_NONE :: ConflictDetectionType | |
| pattern ConflictDetectionType_VERSION :: ConflictDetectionType |
Instances
ConflictHandlerType
newtype ConflictHandlerType Source #
Constructors
| ConflictHandlerType' | |
Fields | |
Bundled Patterns
| pattern ConflictHandlerType_AUTOMERGE :: ConflictHandlerType | |
| pattern ConflictHandlerType_LAMBDA :: ConflictHandlerType | |
| pattern ConflictHandlerType_NONE :: ConflictHandlerType | |
| pattern ConflictHandlerType_OPTIMISTIC_CONCURRENCY :: ConflictHandlerType |
Instances
DataSourceType
newtype DataSourceType Source #
Constructors
| DataSourceType' | |
Fields | |
Bundled Patterns
| pattern DataSourceType_AMAZON_DYNAMODB :: DataSourceType | |
| pattern DataSourceType_AMAZON_ELASTICSEARCH :: DataSourceType | |
| pattern DataSourceType_AMAZON_OPENSEARCH_SERVICE :: DataSourceType | |
| pattern DataSourceType_AWS_LAMBDA :: DataSourceType | |
| pattern DataSourceType_HTTP :: DataSourceType | |
| pattern DataSourceType_NONE :: DataSourceType | |
| pattern DataSourceType_RELATIONAL_DATABASE :: DataSourceType |
Instances
DefaultAction
newtype DefaultAction Source #
Constructors
| DefaultAction' | |
Fields | |
Bundled Patterns
| pattern DefaultAction_ALLOW :: DefaultAction | |
| pattern DefaultAction_DENY :: DefaultAction |
Instances
FieldLogLevel
newtype FieldLogLevel Source #
Constructors
| FieldLogLevel' | |
Fields | |
Bundled Patterns
| pattern FieldLogLevel_ALL :: FieldLogLevel | |
| pattern FieldLogLevel_ERROR :: FieldLogLevel | |
| pattern FieldLogLevel_NONE :: FieldLogLevel |
Instances
OutputType
newtype OutputType Source #
Constructors
| OutputType' | |
Fields | |
Bundled Patterns
| pattern OutputType_JSON :: OutputType | |
| pattern OutputType_SDL :: OutputType |
Instances
RelationalDatabaseSourceType
newtype RelationalDatabaseSourceType Source #
Constructors
| RelationalDatabaseSourceType' | |
Fields | |
Bundled Patterns
| pattern RelationalDatabaseSourceType_RDS_HTTP_ENDPOINT :: RelationalDatabaseSourceType |
Instances
ResolverKind
newtype ResolverKind Source #
Constructors
| ResolverKind' | |
Fields | |
Bundled Patterns
| pattern ResolverKind_PIPELINE :: ResolverKind | |
| pattern ResolverKind_UNIT :: ResolverKind |
Instances
RuntimeName
newtype RuntimeName Source #
Constructors
| RuntimeName' | |
Fields | |
Bundled Patterns
| pattern RuntimeName_APPSYNC_JS :: RuntimeName |
Instances
SchemaStatus
newtype SchemaStatus Source #
Constructors
| SchemaStatus' | |
Fields | |
Bundled Patterns
| pattern SchemaStatus_ACTIVE :: SchemaStatus | |
| pattern SchemaStatus_DELETING :: SchemaStatus | |
| pattern SchemaStatus_FAILED :: SchemaStatus | |
| pattern SchemaStatus_NOT_APPLICABLE :: SchemaStatus | |
| pattern SchemaStatus_PROCESSING :: SchemaStatus | |
| pattern SchemaStatus_SUCCESS :: SchemaStatus |
Instances
TypeDefinitionFormat
newtype TypeDefinitionFormat Source #
Constructors
| TypeDefinitionFormat' | |
Fields | |
Bundled Patterns
| pattern TypeDefinitionFormat_JSON :: TypeDefinitionFormat | |
| pattern TypeDefinitionFormat_SDL :: TypeDefinitionFormat |
Instances
AdditionalAuthenticationProvider
data AdditionalAuthenticationProvider Source #
Describes an additional authentication provider.
See: newAdditionalAuthenticationProvider smart constructor.
Constructors
| AdditionalAuthenticationProvider' | |
Fields
| |
Instances
newAdditionalAuthenticationProvider :: AdditionalAuthenticationProvider Source #
Create a value of AdditionalAuthenticationProvider 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:authenticationType:AdditionalAuthenticationProvider', additionalAuthenticationProvider_authenticationType - The authentication type: API key, Identity and Access Management (IAM),
OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
$sel:lambdaAuthorizerConfig:AdditionalAuthenticationProvider', additionalAuthenticationProvider_lambdaAuthorizerConfig - Configuration for Lambda function authorization.
$sel:openIDConnectConfig:AdditionalAuthenticationProvider', additionalAuthenticationProvider_openIDConnectConfig - The OIDC configuration.
$sel:userPoolConfig:AdditionalAuthenticationProvider', additionalAuthenticationProvider_userPoolConfig - The Amazon Cognito user pool configuration.
additionalAuthenticationProvider_authenticationType :: Lens' AdditionalAuthenticationProvider (Maybe AuthenticationType) Source #
The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
additionalAuthenticationProvider_lambdaAuthorizerConfig :: Lens' AdditionalAuthenticationProvider (Maybe LambdaAuthorizerConfig) Source #
Configuration for Lambda function authorization.
additionalAuthenticationProvider_openIDConnectConfig :: Lens' AdditionalAuthenticationProvider (Maybe OpenIDConnectConfig) Source #
The OIDC configuration.
additionalAuthenticationProvider_userPoolConfig :: Lens' AdditionalAuthenticationProvider (Maybe CognitoUserPoolConfig) Source #
The Amazon Cognito user pool configuration.
ApiAssociation
data ApiAssociation Source #
Describes an ApiAssociation object.
See: newApiAssociation smart constructor.
Constructors
| ApiAssociation' | |
Fields
| |
Instances
newApiAssociation :: ApiAssociation Source #
Create a value of ApiAssociation 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:apiId:ApiAssociation', apiAssociation_apiId - The API ID.
$sel:associationStatus:ApiAssociation', apiAssociation_associationStatus - Identifies the status of an association.
- PROCESSING: The API association is being created. You cannot modify association requests during processing.
- SUCCESS: The API association was successful. You can modify associations after success.
- FAILED: The API association has failed. You can modify associations after failure.
$sel:deploymentDetail:ApiAssociation', apiAssociation_deploymentDetail - Details about the last deployment status.
$sel:domainName:ApiAssociation', apiAssociation_domainName - The domain name.
apiAssociation_apiId :: Lens' ApiAssociation (Maybe Text) Source #
The API ID.
apiAssociation_associationStatus :: Lens' ApiAssociation (Maybe AssociationStatus) Source #
Identifies the status of an association.
- PROCESSING: The API association is being created. You cannot modify association requests during processing.
- SUCCESS: The API association was successful. You can modify associations after success.
- FAILED: The API association has failed. You can modify associations after failure.
apiAssociation_deploymentDetail :: Lens' ApiAssociation (Maybe Text) Source #
Details about the last deployment status.
apiAssociation_domainName :: Lens' ApiAssociation (Maybe Text) Source #
The domain name.
ApiCache
The ApiCache object.
See: newApiCache smart constructor.
Constructors
| ApiCache' | |
Fields
| |
Instances
newApiCache :: ApiCache Source #
Create a value of ApiCache 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:apiCachingBehavior:ApiCache', apiCache_apiCachingBehavior - Caching behavior.
- FULL_REQUEST_CACHING: All requests are fully cached.
- PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
$sel:atRestEncryptionEnabled:ApiCache', apiCache_atRestEncryptionEnabled - At-rest encryption flag for cache. You cannot update this setting after
creation.
$sel:status:ApiCache', apiCache_status - The cache instance status.
- AVAILABLE: The instance is available for use.
- CREATING: The instance is currently creating.
- DELETING: The instance is currently deleting.
- MODIFYING: The instance is currently modifying.
- FAILED: The instance has failed creation.
$sel:transitEncryptionEnabled:ApiCache', apiCache_transitEncryptionEnabled - Transit encryption flag when connecting to cache. You cannot update this
setting after creation.
$sel:ttl:ApiCache', apiCache_ttl - TTL in seconds for cache entries.
Valid values are 1–3,600 seconds.
$sel:type':ApiCache', apiCache_type - The cache instance type. Valid values are
SMALL
MEDIUM
LARGE
XLARGE
LARGE_2X
LARGE_4X
LARGE_8X(not available in all regions)LARGE_12X
Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.
The following legacy instance types are available, but their use is discouraged:
- T2_SMALL: A t2.small instance type.
- T2_MEDIUM: A t2.medium instance type.
- R4_LARGE: A r4.large instance type.
- R4_XLARGE: A r4.xlarge instance type.
- R4_2XLARGE: A r4.2xlarge instance type.
- R4_4XLARGE: A r4.4xlarge instance type.
- R4_8XLARGE: A r4.8xlarge instance type.
apiCache_apiCachingBehavior :: Lens' ApiCache (Maybe ApiCachingBehavior) Source #
Caching behavior.
- FULL_REQUEST_CACHING: All requests are fully cached.
- PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
apiCache_atRestEncryptionEnabled :: Lens' ApiCache (Maybe Bool) Source #
At-rest encryption flag for cache. You cannot update this setting after creation.
apiCache_status :: Lens' ApiCache (Maybe ApiCacheStatus) Source #
The cache instance status.
- AVAILABLE: The instance is available for use.
- CREATING: The instance is currently creating.
- DELETING: The instance is currently deleting.
- MODIFYING: The instance is currently modifying.
- FAILED: The instance has failed creation.
apiCache_transitEncryptionEnabled :: Lens' ApiCache (Maybe Bool) Source #
Transit encryption flag when connecting to cache. You cannot update this setting after creation.
apiCache_ttl :: Lens' ApiCache (Maybe Integer) Source #
TTL in seconds for cache entries.
Valid values are 1–3,600 seconds.
apiCache_type :: Lens' ApiCache (Maybe ApiCacheType) Source #
The cache instance type. Valid values are
SMALL
MEDIUM
LARGE
XLARGE
LARGE_2X
LARGE_4X
LARGE_8X(not available in all regions)LARGE_12X
Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.
The following legacy instance types are available, but their use is discouraged:
- T2_SMALL: A t2.small instance type.
- T2_MEDIUM: A t2.medium instance type.
- R4_LARGE: A r4.large instance type.
- R4_XLARGE: A r4.xlarge instance type.
- R4_2XLARGE: A r4.2xlarge instance type.
- R4_4XLARGE: A r4.4xlarge instance type.
- R4_8XLARGE: A r4.8xlarge instance type.
ApiKey
Describes an API key.
Customers invoke AppSync GraphQL API operations with API keys as an identity mechanism. There are two key versions:
da1: We introduced this version at launch in November 2017. These keys always expire after 7 days. Amazon DynamoDB TTL manages key expiration. These keys ceased to be valid after February 21, 2018, and they should no longer be used.
ListApiKeysreturns the expiration time in milliseconds.CreateApiKeyreturns the expiration time in milliseconds.UpdateApiKeyis not available for this key version.DeleteApiKeydeletes the item from the table.- Expiration is stored in DynamoDB as milliseconds. This results in a bug where keys are not automatically deleted because DynamoDB expects the TTL to be stored in seconds. As a one-time action, we deleted these keys from the table on February 21, 2018.
da2: We introduced this version in February 2018 when AppSync added support to extend key expiration.
ListApiKeysreturns the expiration time and deletion time in seconds.CreateApiKeyreturns the expiration time and deletion time in seconds and accepts a user-provided expiration time in seconds.UpdateApiKeyreturns the expiration time and and deletion time in seconds and accepts a user-provided expiration time in seconds. Expired API keys are kept for 60 days after the expiration time. You can update the key expiration time as long as the key isn't deleted.DeleteApiKeydeletes the item from the table.- Expiration is stored in DynamoDB as seconds. After the expiration time, using the key to authenticate will fail. However, you can reinstate the key before deletion.
- Deletion is stored in DynamoDB as seconds. The key is deleted after deletion time.
See: newApiKey smart constructor.
Constructors
| ApiKey' | |
Fields
| |
Instances
| FromJSON ApiKey Source # | |
| Generic ApiKey Source # | |
| Read ApiKey Source # | |
| Show ApiKey Source # | |
| NFData ApiKey Source # | |
Defined in Amazonka.AppSync.Types.ApiKey | |
| Eq ApiKey Source # | |
| Hashable ApiKey Source # | |
Defined in Amazonka.AppSync.Types.ApiKey | |
| type Rep ApiKey Source # | |
Defined in Amazonka.AppSync.Types.ApiKey type Rep ApiKey = D1 ('MetaData "ApiKey" "Amazonka.AppSync.Types.ApiKey" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" 'False) (C1 ('MetaCons "ApiKey'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "deletes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "expires") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) | |
Create a value of ApiKey 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:deletes:ApiKey', apiKey_deletes - The time after which the API key is deleted. The date is represented as
seconds since the epoch, rounded down to the nearest hour.
$sel:description:ApiKey', apiKey_description - A description of the purpose of the API key.
$sel:expires:ApiKey', apiKey_expires - The time after which the API key expires. The date is represented as
seconds since the epoch, rounded down to the nearest hour.
$sel:id:ApiKey', apiKey_id - The API key ID.
apiKey_deletes :: Lens' ApiKey (Maybe Integer) Source #
The time after which the API key is deleted. The date is represented as seconds since the epoch, rounded down to the nearest hour.
apiKey_description :: Lens' ApiKey (Maybe Text) Source #
A description of the purpose of the API key.
apiKey_expires :: Lens' ApiKey (Maybe Integer) Source #
The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour.
AppSyncRuntime
data AppSyncRuntime Source #
Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.
See: newAppSyncRuntime smart constructor.
Constructors
| AppSyncRuntime' | |
Fields
| |
Instances
Arguments
| :: RuntimeName | |
| -> Text | |
| -> AppSyncRuntime |
Create a value of AppSyncRuntime 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:name:AppSyncRuntime', appSyncRuntime_name - The name of the runtime to use. Currently, the only allowed value is
APPSYNC_JS.
$sel:runtimeVersion:AppSyncRuntime', appSyncRuntime_runtimeVersion - The version of the runtime to use. Currently, the only allowed version
is 1.0.0.
appSyncRuntime_name :: Lens' AppSyncRuntime RuntimeName Source #
The name of the runtime to use. Currently, the only allowed value is
APPSYNC_JS.
appSyncRuntime_runtimeVersion :: Lens' AppSyncRuntime Text Source #
The version of the runtime to use. Currently, the only allowed version
is 1.0.0.
AuthorizationConfig
data AuthorizationConfig Source #
The authorization configuration in case the HTTP endpoint requires authorization.
See: newAuthorizationConfig smart constructor.
Constructors
| AuthorizationConfig' | |
Fields
| |
Instances
newAuthorizationConfig Source #
Create a value of AuthorizationConfig 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:awsIamConfig:AuthorizationConfig', authorizationConfig_awsIamConfig - The Identity and Access Management (IAM) settings.
$sel:authorizationType:AuthorizationConfig', authorizationConfig_authorizationType - The authorization type that the HTTP endpoint requires.
- AWS_IAM: The authorization type is Signature Version 4 (SigV4).
authorizationConfig_awsIamConfig :: Lens' AuthorizationConfig (Maybe AwsIamConfig) Source #
The Identity and Access Management (IAM) settings.
authorizationConfig_authorizationType :: Lens' AuthorizationConfig AuthorizationType Source #
The authorization type that the HTTP endpoint requires.
- AWS_IAM: The authorization type is Signature Version 4 (SigV4).
AwsIamConfig
data AwsIamConfig Source #
The Identity and Access Management (IAM) configuration.
See: newAwsIamConfig smart constructor.
Constructors
| AwsIamConfig' | |
Fields
| |
Instances
newAwsIamConfig :: AwsIamConfig Source #
Create a value of AwsIamConfig 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:signingRegion:AwsIamConfig', awsIamConfig_signingRegion - The signing Amazon Web Services Region for IAM authorization.
$sel:signingServiceName:AwsIamConfig', awsIamConfig_signingServiceName - The signing service name for IAM authorization.
awsIamConfig_signingRegion :: Lens' AwsIamConfig (Maybe Text) Source #
The signing Amazon Web Services Region for IAM authorization.
awsIamConfig_signingServiceName :: Lens' AwsIamConfig (Maybe Text) Source #
The signing service name for IAM authorization.
CachingConfig
data CachingConfig Source #
The caching configuration for a resolver that has caching activated.
See: newCachingConfig smart constructor.
Constructors
| CachingConfig' | |
Fields
| |
Instances
Arguments
| :: Integer | |
| -> CachingConfig |
Create a value of CachingConfig 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:cachingKeys:CachingConfig', cachingConfig_cachingKeys - The caching keys for a resolver that has caching activated.
Valid values are entries from the $context.arguments,
$context.source, and $context.identity maps.
$sel:ttl:CachingConfig', cachingConfig_ttl - The TTL in seconds for a resolver that has caching activated.
Valid values are 1–3,600 seconds.
cachingConfig_cachingKeys :: Lens' CachingConfig (Maybe [Text]) Source #
The caching keys for a resolver that has caching activated.
Valid values are entries from the $context.arguments,
$context.source, and $context.identity maps.
cachingConfig_ttl :: Lens' CachingConfig Integer Source #
The TTL in seconds for a resolver that has caching activated.
Valid values are 1–3,600 seconds.
CodeError
Describes an AppSync error.
See: newCodeError smart constructor.
Constructors
| CodeError' | |
Fields
| |
Instances
| FromJSON CodeError Source # | |
| Generic CodeError Source # | |
| Read CodeError Source # | |
| Show CodeError Source # | |
| NFData CodeError Source # | |
Defined in Amazonka.AppSync.Types.CodeError | |
| Eq CodeError Source # | |
| Hashable CodeError Source # | |
Defined in Amazonka.AppSync.Types.CodeError | |
| type Rep CodeError Source # | |
Defined in Amazonka.AppSync.Types.CodeError type Rep CodeError = D1 ('MetaData "CodeError" "Amazonka.AppSync.Types.CodeError" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" 'False) (C1 ('MetaCons "CodeError'" 'PrefixI 'True) (S1 ('MetaSel ('Just "errorType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CodeErrorLocation)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) | |
newCodeError :: CodeError Source #
Create a value of CodeError 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:errorType:CodeError', codeError_errorType - The type of code error.
Examples include, but aren't limited to: LINT_ERROR, PARSER_ERROR.
$sel:location:CodeError', codeError_location - The line, column, and span location of the error in the code.
$sel:value:CodeError', codeError_value - A user presentable error.
Examples include, but aren't limited to:
Parsing error: Unterminated string literal.
codeError_errorType :: Lens' CodeError (Maybe Text) Source #
The type of code error.
Examples include, but aren't limited to: LINT_ERROR, PARSER_ERROR.
codeError_location :: Lens' CodeError (Maybe CodeErrorLocation) Source #
The line, column, and span location of the error in the code.
codeError_value :: Lens' CodeError (Maybe Text) Source #
A user presentable error.
Examples include, but aren't limited to:
Parsing error: Unterminated string literal.
CodeErrorLocation
data CodeErrorLocation Source #
Describes the location of the error in a code sample.
See: newCodeErrorLocation smart constructor.
Constructors
| CodeErrorLocation' | |
Instances
newCodeErrorLocation :: CodeErrorLocation Source #
Create a value of CodeErrorLocation 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:column:CodeErrorLocation', codeErrorLocation_column - The column number in the code. Defaults to 0 if unknown.
$sel:line:CodeErrorLocation', codeErrorLocation_line - The line number in the code. Defaults to 0 if unknown.
$sel:span:CodeErrorLocation', codeErrorLocation_span - The span/length of the error. Defaults to -1 if unknown.
codeErrorLocation_column :: Lens' CodeErrorLocation (Maybe Int) Source #
The column number in the code. Defaults to 0 if unknown.
codeErrorLocation_line :: Lens' CodeErrorLocation (Maybe Int) Source #
The line number in the code. Defaults to 0 if unknown.
codeErrorLocation_span :: Lens' CodeErrorLocation (Maybe Int) Source #
The span/length of the error. Defaults to -1 if unknown.
CognitoUserPoolConfig
data CognitoUserPoolConfig Source #
Describes an Amazon Cognito user pool configuration.
See: newCognitoUserPoolConfig smart constructor.
Constructors
| CognitoUserPoolConfig' | |
Fields
| |
Instances
newCognitoUserPoolConfig Source #
Arguments
| :: Text | |
| -> Text | |
| -> CognitoUserPoolConfig |
Create a value of CognitoUserPoolConfig 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:appIdClientRegex:CognitoUserPoolConfig', cognitoUserPoolConfig_appIdClientRegex - A regular expression for validating the incoming Amazon Cognito user
pool app client ID. If this value isn't set, no filtering is applied.
$sel:userPoolId:CognitoUserPoolConfig', cognitoUserPoolConfig_userPoolId - The user pool ID.
$sel:awsRegion:CognitoUserPoolConfig', cognitoUserPoolConfig_awsRegion - The Amazon Web Services Region in which the user pool was created.
cognitoUserPoolConfig_appIdClientRegex :: Lens' CognitoUserPoolConfig (Maybe Text) Source #
A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied.
cognitoUserPoolConfig_userPoolId :: Lens' CognitoUserPoolConfig Text Source #
The user pool ID.
cognitoUserPoolConfig_awsRegion :: Lens' CognitoUserPoolConfig Text Source #
The Amazon Web Services Region in which the user pool was created.
DataSource
data DataSource Source #
Describes a data source.
See: newDataSource smart constructor.
Constructors
| DataSource' | |
Fields
| |
Instances
newDataSource :: DataSource Source #
Create a value of DataSource 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:dataSourceArn:DataSource', dataSource_dataSourceArn - The data source Amazon Resource Name (ARN).
$sel:description:DataSource', dataSource_description - The description of the data source.
$sel:dynamodbConfig:DataSource', dataSource_dynamodbConfig - DynamoDB settings.
$sel:elasticsearchConfig:DataSource', dataSource_elasticsearchConfig - Amazon OpenSearch Service settings.
$sel:httpConfig:DataSource', dataSource_httpConfig - HTTP endpoint settings.
$sel:lambdaConfig:DataSource', dataSource_lambdaConfig - Lambda settings.
$sel:name:DataSource', dataSource_name - The name of the data source.
$sel:openSearchServiceConfig:DataSource', dataSource_openSearchServiceConfig - Amazon OpenSearch Service settings.
$sel:relationalDatabaseConfig:DataSource', dataSource_relationalDatabaseConfig - Relational database settings.
$sel:serviceRoleArn:DataSource', dataSource_serviceRoleArn - The Identity and Access Management (IAM) service role Amazon Resource
Name (ARN) for the data source. The system assumes this role when
accessing the data source.
$sel:type':DataSource', dataSource_type - The type of the data source.
- AWS_LAMBDA: The data source is an Lambda function.
- AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table.
- AMAZON_ELASTICSEARCH: The data source is an Amazon OpenSearch Service domain.
- AMAZON_OPENSEARCH_SERVICE: The data source is an Amazon OpenSearch Service domain.
- NONE: There is no data source. Use this type when you want to invoke a GraphQL operation without connecting to a data source, such as when you're performing data transformation with resolvers or invoking a subscription from a mutation.
- HTTP: The data source is an HTTP endpoint.
- RELATIONAL_DATABASE: The data source is a relational database.
dataSource_dataSourceArn :: Lens' DataSource (Maybe Text) Source #
The data source Amazon Resource Name (ARN).
dataSource_description :: Lens' DataSource (Maybe Text) Source #
The description of the data source.
dataSource_dynamodbConfig :: Lens' DataSource (Maybe DynamodbDataSourceConfig) Source #
DynamoDB settings.
dataSource_elasticsearchConfig :: Lens' DataSource (Maybe ElasticsearchDataSourceConfig) Source #
Amazon OpenSearch Service settings.
dataSource_httpConfig :: Lens' DataSource (Maybe HttpDataSourceConfig) Source #
HTTP endpoint settings.
dataSource_lambdaConfig :: Lens' DataSource (Maybe LambdaDataSourceConfig) Source #
Lambda settings.
dataSource_name :: Lens' DataSource (Maybe Text) Source #
The name of the data source.
dataSource_openSearchServiceConfig :: Lens' DataSource (Maybe OpenSearchServiceDataSourceConfig) Source #
Amazon OpenSearch Service settings.
dataSource_relationalDatabaseConfig :: Lens' DataSource (Maybe RelationalDatabaseDataSourceConfig) Source #
Relational database settings.
dataSource_serviceRoleArn :: Lens' DataSource (Maybe Text) Source #
The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source. The system assumes this role when accessing the data source.
dataSource_type :: Lens' DataSource (Maybe DataSourceType) Source #
The type of the data source.
- AWS_LAMBDA: The data source is an Lambda function.
- AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table.
- AMAZON_ELASTICSEARCH: The data source is an Amazon OpenSearch Service domain.
- AMAZON_OPENSEARCH_SERVICE: The data source is an Amazon OpenSearch Service domain.
- NONE: There is no data source. Use this type when you want to invoke a GraphQL operation without connecting to a data source, such as when you're performing data transformation with resolvers or invoking a subscription from a mutation.
- HTTP: The data source is an HTTP endpoint.
- RELATIONAL_DATABASE: The data source is a relational database.
DeltaSyncConfig
data DeltaSyncConfig Source #
Describes a Delta Sync configuration.
See: newDeltaSyncConfig smart constructor.
Constructors
| DeltaSyncConfig' | |
Fields
| |
Instances
newDeltaSyncConfig :: DeltaSyncConfig Source #
Create a value of DeltaSyncConfig 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:baseTableTTL:DeltaSyncConfig', deltaSyncConfig_baseTableTTL - The number of minutes that an Item is stored in the data source.
$sel:deltaSyncTableName:DeltaSyncConfig', deltaSyncConfig_deltaSyncTableName - The Delta Sync table name.
$sel:deltaSyncTableTTL:DeltaSyncConfig', deltaSyncConfig_deltaSyncTableTTL - The number of minutes that a Delta Sync log entry is stored in the Delta
Sync table.
deltaSyncConfig_baseTableTTL :: Lens' DeltaSyncConfig (Maybe Integer) Source #
The number of minutes that an Item is stored in the data source.
deltaSyncConfig_deltaSyncTableName :: Lens' DeltaSyncConfig (Maybe Text) Source #
The Delta Sync table name.
deltaSyncConfig_deltaSyncTableTTL :: Lens' DeltaSyncConfig (Maybe Integer) Source #
The number of minutes that a Delta Sync log entry is stored in the Delta Sync table.
DomainNameConfig
data DomainNameConfig Source #
Describes a configuration for a custom domain.
See: newDomainNameConfig smart constructor.
Constructors
| DomainNameConfig' | |
Fields
| |
Instances
newDomainNameConfig :: DomainNameConfig Source #
Create a value of DomainNameConfig 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:appsyncDomainName:DomainNameConfig', domainNameConfig_appsyncDomainName - The domain name that AppSync provides.
$sel:certificateArn:DomainNameConfig', domainNameConfig_certificateArn - The Amazon Resource Name (ARN) of the certificate. This can be an
Certificate Manager (ACM) certificate or an Identity and Access
Management (IAM) server certificate.
$sel:description:DomainNameConfig', domainNameConfig_description - A description of the DomainName configuration.
$sel:domainName:DomainNameConfig', domainNameConfig_domainName - The domain name.
$sel:hostedZoneId:DomainNameConfig', domainNameConfig_hostedZoneId - The ID of your Amazon Route 53 hosted zone.
domainNameConfig_appsyncDomainName :: Lens' DomainNameConfig (Maybe Text) Source #
The domain name that AppSync provides.
domainNameConfig_certificateArn :: Lens' DomainNameConfig (Maybe Text) Source #
The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate.
domainNameConfig_description :: Lens' DomainNameConfig (Maybe Text) Source #
A description of the DomainName configuration.
domainNameConfig_domainName :: Lens' DomainNameConfig (Maybe Text) Source #
The domain name.
domainNameConfig_hostedZoneId :: Lens' DomainNameConfig (Maybe Text) Source #
The ID of your Amazon Route 53 hosted zone.
DynamodbDataSourceConfig
data DynamodbDataSourceConfig Source #
Describes an Amazon DynamoDB data source configuration.
See: newDynamodbDataSourceConfig smart constructor.
Constructors
| DynamodbDataSourceConfig' | |
Fields
| |
Instances
newDynamodbDataSourceConfig Source #
Arguments
| :: Text | |
| -> Text | |
| -> DynamodbDataSourceConfig |
Create a value of DynamodbDataSourceConfig 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:deltaSyncConfig:DynamodbDataSourceConfig', dynamodbDataSourceConfig_deltaSyncConfig - The DeltaSyncConfig for a versioned data source.
$sel:useCallerCredentials:DynamodbDataSourceConfig', dynamodbDataSourceConfig_useCallerCredentials - Set to TRUE to use Amazon Cognito credentials with this data source.
$sel:versioned:DynamodbDataSourceConfig', dynamodbDataSourceConfig_versioned - Set to TRUE to use Conflict Detection and Resolution with this data
source.
$sel:tableName:DynamodbDataSourceConfig', dynamodbDataSourceConfig_tableName - The table name.
$sel:awsRegion:DynamodbDataSourceConfig', dynamodbDataSourceConfig_awsRegion - The Amazon Web Services Region.
dynamodbDataSourceConfig_deltaSyncConfig :: Lens' DynamodbDataSourceConfig (Maybe DeltaSyncConfig) Source #
The DeltaSyncConfig for a versioned data source.
dynamodbDataSourceConfig_useCallerCredentials :: Lens' DynamodbDataSourceConfig (Maybe Bool) Source #
Set to TRUE to use Amazon Cognito credentials with this data source.
dynamodbDataSourceConfig_versioned :: Lens' DynamodbDataSourceConfig (Maybe Bool) Source #
Set to TRUE to use Conflict Detection and Resolution with this data source.
dynamodbDataSourceConfig_tableName :: Lens' DynamodbDataSourceConfig Text Source #
The table name.
dynamodbDataSourceConfig_awsRegion :: Lens' DynamodbDataSourceConfig Text Source #
The Amazon Web Services Region.
ElasticsearchDataSourceConfig
data ElasticsearchDataSourceConfig Source #
Describes an OpenSearch data source configuration.
As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is deprecated. For new data sources, use OpenSearchServiceDataSourceConfig to specify an OpenSearch data source.
See: newElasticsearchDataSourceConfig smart constructor.
Constructors
| ElasticsearchDataSourceConfig' | |
Instances
newElasticsearchDataSourceConfig Source #
Arguments
| :: Text | |
| -> Text | |
| -> ElasticsearchDataSourceConfig |
Create a value of ElasticsearchDataSourceConfig 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:endpoint:ElasticsearchDataSourceConfig', elasticsearchDataSourceConfig_endpoint - The endpoint.
$sel:awsRegion:ElasticsearchDataSourceConfig', elasticsearchDataSourceConfig_awsRegion - The Amazon Web Services Region.
elasticsearchDataSourceConfig_endpoint :: Lens' ElasticsearchDataSourceConfig Text Source #
The endpoint.
elasticsearchDataSourceConfig_awsRegion :: Lens' ElasticsearchDataSourceConfig Text Source #
The Amazon Web Services Region.
ErrorDetail
data ErrorDetail Source #
Contains the list of errors generated. When using JavaScript, this will apply to the request or response function evaluation.
See: newErrorDetail smart constructor.
Constructors
| ErrorDetail' | |
Instances
newErrorDetail :: ErrorDetail Source #
Create a value of ErrorDetail 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:message:ErrorDetail', errorDetail_message - The error payload.
errorDetail_message :: Lens' ErrorDetail (Maybe Text) Source #
The error payload.
EvaluateCodeErrorDetail
data EvaluateCodeErrorDetail Source #
Contains the list of errors from a code evaluation response.
See: newEvaluateCodeErrorDetail smart constructor.
Constructors
| EvaluateCodeErrorDetail' | |
Instances
newEvaluateCodeErrorDetail :: EvaluateCodeErrorDetail Source #
Create a value of EvaluateCodeErrorDetail 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:codeErrors:EvaluateCodeErrorDetail', evaluateCodeErrorDetail_codeErrors - Contains the list of CodeError objects.
$sel:message:EvaluateCodeErrorDetail', evaluateCodeErrorDetail_message - The error payload.
evaluateCodeErrorDetail_codeErrors :: Lens' EvaluateCodeErrorDetail (Maybe [CodeError]) Source #
Contains the list of CodeError objects.
evaluateCodeErrorDetail_message :: Lens' EvaluateCodeErrorDetail (Maybe Text) Source #
The error payload.
FunctionConfiguration
data FunctionConfiguration Source #
A function is a reusable entity. You can use multiple functions to compose the resolver logic.
See: newFunctionConfiguration smart constructor.
Constructors
| FunctionConfiguration' | |
Fields
| |
Instances
newFunctionConfiguration :: FunctionConfiguration Source #
Create a value of FunctionConfiguration 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:code:FunctionConfiguration', functionConfiguration_code - The function code that contains the request and response functions.
When code is used, the runtime is required. The runtime value must
be APPSYNC_JS.
$sel:dataSourceName:FunctionConfiguration', functionConfiguration_dataSourceName - The name of the DataSource.
$sel:description:FunctionConfiguration', functionConfiguration_description - The Function description.
$sel:functionArn:FunctionConfiguration', functionConfiguration_functionArn - The Amazon Resource Name (ARN) of the Function object.
$sel:functionId:FunctionConfiguration', functionConfiguration_functionId - A unique ID representing the Function object.
$sel:functionVersion:FunctionConfiguration', functionConfiguration_functionVersion - The version of the request mapping template. Currently, only the
2018-05-29 version of the template is supported.
$sel:maxBatchSize:FunctionConfiguration', functionConfiguration_maxBatchSize - The maximum batching size for a resolver.
FunctionConfiguration, functionConfiguration_name - The name of the Function object.
$sel:requestMappingTemplate:FunctionConfiguration', functionConfiguration_requestMappingTemplate - The Function request mapping template. Functions support only the
2018-05-29 version of the request mapping template.
$sel:responseMappingTemplate:FunctionConfiguration', functionConfiguration_responseMappingTemplate - The Function response mapping template.
$sel:runtime:FunctionConfiguration', functionConfiguration_runtime - Undocumented member.
$sel:syncConfig:FunctionConfiguration', functionConfiguration_syncConfig - Undocumented member.
functionConfiguration_code :: Lens' FunctionConfiguration (Maybe Text) Source #
The function code that contains the request and response functions.
When code is used, the runtime is required. The runtime value must
be APPSYNC_JS.
functionConfiguration_dataSourceName :: Lens' FunctionConfiguration (Maybe Text) Source #
The name of the DataSource.
functionConfiguration_description :: Lens' FunctionConfiguration (Maybe Text) Source #
The Function description.
functionConfiguration_functionArn :: Lens' FunctionConfiguration (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Function object.
functionConfiguration_functionId :: Lens' FunctionConfiguration (Maybe Text) Source #
A unique ID representing the Function object.
functionConfiguration_functionVersion :: Lens' FunctionConfiguration (Maybe Text) Source #
The version of the request mapping template. Currently, only the 2018-05-29 version of the template is supported.
functionConfiguration_maxBatchSize :: Lens' FunctionConfiguration (Maybe Natural) Source #
The maximum batching size for a resolver.
functionConfiguration_name :: Lens' FunctionConfiguration (Maybe Text) Source #
The name of the Function object.
functionConfiguration_requestMappingTemplate :: Lens' FunctionConfiguration (Maybe Text) Source #
The Function request mapping template. Functions support only the
2018-05-29 version of the request mapping template.
functionConfiguration_responseMappingTemplate :: Lens' FunctionConfiguration (Maybe Text) Source #
The Function response mapping template.
functionConfiguration_runtime :: Lens' FunctionConfiguration (Maybe AppSyncRuntime) Source #
Undocumented member.
functionConfiguration_syncConfig :: Lens' FunctionConfiguration (Maybe SyncConfig) Source #
Undocumented member.
GraphqlApi
data GraphqlApi Source #
Describes a GraphQL API.
See: newGraphqlApi smart constructor.
Constructors
| GraphqlApi' | |
Fields
| |
Instances
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 #
The Amazon CloudWatch Logs configuration.
graphqlApi_name :: Lens' GraphqlApi (Maybe Text) Source #
The API name.
graphqlApi_openIDConnectConfig :: Lens' GraphqlApi (Maybe OpenIDConnectConfig) Source #
The OpenID Connect configuration.
graphqlApi_tags :: Lens' GraphqlApi (Maybe (HashMap Text Text)) Source #
The tags.
graphqlApi_uris :: Lens' GraphqlApi (Maybe (HashMap Text Text)) Source #
The URIs.
graphqlApi_userPoolConfig :: Lens' GraphqlApi (Maybe UserPoolConfig) Source #
The Amazon Cognito user pool configuration.
graphqlApi_wafWebAclArn :: Lens' GraphqlApi (Maybe Text) Source #
The ARN of the WAF access control list (ACL) associated with this
GraphqlApi, if one exists.
graphqlApi_xrayEnabled :: Lens' GraphqlApi (Maybe Bool) Source #
A flag indicating whether to use X-Ray tracing for this GraphqlApi.
HttpDataSourceConfig
data HttpDataSourceConfig Source #
Describes an HTTP data source configuration.
See: newHttpDataSourceConfig smart constructor.
Constructors
| HttpDataSourceConfig' | |
Fields
| |
Instances
newHttpDataSourceConfig :: HttpDataSourceConfig Source #
Create a value of HttpDataSourceConfig 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:authorizationConfig:HttpDataSourceConfig', httpDataSourceConfig_authorizationConfig - The authorization configuration in case the HTTP endpoint requires
authorization.
$sel:endpoint:HttpDataSourceConfig', httpDataSourceConfig_endpoint - The HTTP URL endpoint. You can specify either the domain name or IP, and
port combination, and the URL scheme must be HTTP or HTTPS. If you
don't specify the port, AppSync uses the default port 80 for the HTTP
endpoint and port 443 for HTTPS endpoints.
httpDataSourceConfig_authorizationConfig :: Lens' HttpDataSourceConfig (Maybe AuthorizationConfig) Source #
The authorization configuration in case the HTTP endpoint requires authorization.
httpDataSourceConfig_endpoint :: Lens' HttpDataSourceConfig (Maybe Text) Source #
The HTTP URL endpoint. You can specify either the domain name or IP, and port combination, and the URL scheme must be HTTP or HTTPS. If you don't specify the port, AppSync uses the default port 80 for the HTTP endpoint and port 443 for HTTPS endpoints.
LambdaAuthorizerConfig
data LambdaAuthorizerConfig Source #
A LambdaAuthorizerConfig specifies how to authorize AppSync API access
when using the AWS_LAMBDA authorizer mode. Be aware that an AppSync
API can have only one Lambda authorizer configured at a time.
See: newLambdaAuthorizerConfig smart constructor.
Constructors
| LambdaAuthorizerConfig' | |
Fields
| |
Instances
newLambdaAuthorizerConfig Source #
Create a value of LambdaAuthorizerConfig 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:authorizerResultTtlInSeconds:LambdaAuthorizerConfig', lambdaAuthorizerConfig_authorizerResultTtlInSeconds - The number of seconds a response should be cached for. The default is 5
minutes (300 seconds). The Lambda function can override this by
returning a ttlOverride key in its response. A value of 0 disables
caching of responses.
$sel:identityValidationExpression:LambdaAuthorizerConfig', lambdaAuthorizerConfig_identityValidationExpression - A regular expression for validation of tokens before the Lambda function
is called.
$sel:authorizerUri:LambdaAuthorizerConfig', lambdaAuthorizerConfig_authorizerUri - The Amazon Resource Name (ARN) of the Lambda function to be called for
authorization. This can be a standard Lambda ARN, a version ARN
(.../v3), or an alias ARN.
Note: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is done for you. To use the Command Line Interface (CLI), run the following:
aws lambda add-permission --function-name "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id "appsync" --principal appsync.amazonaws.com --action lambda:InvokeFunction
lambdaAuthorizerConfig_authorizerResultTtlInSeconds :: Lens' LambdaAuthorizerConfig (Maybe Natural) Source #
The number of seconds a response should be cached for. The default is 5
minutes (300 seconds). The Lambda function can override this by
returning a ttlOverride key in its response. A value of 0 disables
caching of responses.
lambdaAuthorizerConfig_identityValidationExpression :: Lens' LambdaAuthorizerConfig (Maybe Text) Source #
A regular expression for validation of tokens before the Lambda function is called.
lambdaAuthorizerConfig_authorizerUri :: Lens' LambdaAuthorizerConfig Text Source #
The Amazon Resource Name (ARN) of the Lambda function to be called for
authorization. This can be a standard Lambda ARN, a version ARN
(.../v3), or an alias ARN.
Note: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is done for you. To use the Command Line Interface (CLI), run the following:
aws lambda add-permission --function-name "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id "appsync" --principal appsync.amazonaws.com --action lambda:InvokeFunction
LambdaConflictHandlerConfig
data LambdaConflictHandlerConfig Source #
The LambdaConflictHandlerConfig object when configuring LAMBDA as
the Conflict Handler.
See: newLambdaConflictHandlerConfig smart constructor.
Constructors
| LambdaConflictHandlerConfig' | |
Fields
| |
Instances
newLambdaConflictHandlerConfig :: LambdaConflictHandlerConfig Source #
Create a value of LambdaConflictHandlerConfig 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:lambdaConflictHandlerArn:LambdaConflictHandlerConfig', lambdaConflictHandlerConfig_lambdaConflictHandlerArn - The Amazon Resource Name (ARN) for the Lambda function to use as the
Conflict Handler.
lambdaConflictHandlerConfig_lambdaConflictHandlerArn :: Lens' LambdaConflictHandlerConfig (Maybe Text) Source #
The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.
LambdaDataSourceConfig
data LambdaDataSourceConfig Source #
Describes an Lambda data source configuration.
See: newLambdaDataSourceConfig smart constructor.
Constructors
| LambdaDataSourceConfig' | |
Fields
| |
Instances
newLambdaDataSourceConfig Source #
Create a value of LambdaDataSourceConfig 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:lambdaFunctionArn:LambdaDataSourceConfig', lambdaDataSourceConfig_lambdaFunctionArn - The Amazon Resource Name (ARN) for the Lambda function.
lambdaDataSourceConfig_lambdaFunctionArn :: Lens' LambdaDataSourceConfig Text Source #
The Amazon Resource Name (ARN) for the Lambda function.
LogConfig
The Amazon CloudWatch Logs configuration.
See: newLogConfig smart constructor.
Constructors
| LogConfig' | |
Fields
| |
Instances
| FromJSON LogConfig Source # | |
| ToJSON LogConfig Source # | |
Defined in Amazonka.AppSync.Types.LogConfig | |
| Generic LogConfig Source # | |
| Read LogConfig Source # | |
| Show LogConfig Source # | |
| NFData LogConfig Source # | |
Defined in Amazonka.AppSync.Types.LogConfig | |
| Eq LogConfig Source # | |
| Hashable LogConfig Source # | |
Defined in Amazonka.AppSync.Types.LogConfig | |
| type Rep LogConfig Source # | |
Defined in Amazonka.AppSync.Types.LogConfig type Rep LogConfig = D1 ('MetaData "LogConfig" "Amazonka.AppSync.Types.LogConfig" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" 'False) (C1 ('MetaCons "LogConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "excludeVerboseContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "fieldLogLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FieldLogLevel) :*: S1 ('MetaSel ('Just "cloudWatchLogsRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) | |
Arguments
| :: FieldLogLevel | |
| -> Text | |
| -> LogConfig |
Create a value of LogConfig 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:excludeVerboseContent:LogConfig', logConfig_excludeVerboseContent - Set to TRUE to exclude sections that contain information such as
headers, context, and evaluated mapping templates, regardless of logging
level.
$sel:fieldLogLevel:LogConfig', logConfig_fieldLogLevel - The field logging level. Values can be NONE, ERROR, or ALL.
- NONE: No field-level logs are captured.
ERROR: Logs the following information only for the fields that are in error:
- The error section in the server response.
- Field-level errors.
- The generated request/response functions that got resolved for error fields.
ALL: The following information is logged for all fields in the query:
- Field-level tracing information.
- The generated request/response functions that got resolved for each field.
$sel:cloudWatchLogsRoleArn:LogConfig', logConfig_cloudWatchLogsRoleArn - The service role that AppSync assumes to publish to CloudWatch logs in
your account.
logConfig_excludeVerboseContent :: Lens' LogConfig (Maybe Bool) Source #
Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.
logConfig_fieldLogLevel :: Lens' LogConfig FieldLogLevel Source #
The field logging level. Values can be NONE, ERROR, or ALL.
- NONE: No field-level logs are captured.
ERROR: Logs the following information only for the fields that are in error:
- The error section in the server response.
- Field-level errors.
- The generated request/response functions that got resolved for error fields.
ALL: The following information is logged for all fields in the query:
- Field-level tracing information.
- The generated request/response functions that got resolved for each field.
logConfig_cloudWatchLogsRoleArn :: Lens' LogConfig Text Source #
The service role that AppSync assumes to publish to CloudWatch logs in your account.
OpenIDConnectConfig
data OpenIDConnectConfig Source #
Describes an OpenID Connect (OIDC) configuration.
See: newOpenIDConnectConfig smart constructor.
Constructors
| OpenIDConnectConfig' | |
Fields
| |
Instances
newOpenIDConnectConfig Source #
Arguments
| :: Text | |
| -> OpenIDConnectConfig |
Create a value of OpenIDConnectConfig 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:authTTL:OpenIDConnectConfig', openIDConnectConfig_authTTL - The number of milliseconds that a token is valid after being
authenticated.
$sel:clientId:OpenIDConnectConfig', openIDConnectConfig_clientId - The client identifier of the relying party at the OpenID identity
provider. This identifier is typically obtained when the relying party
is registered with the OpenID identity provider. You can specify a
regular expression so that AppSync can validate against multiple client
identifiers at a time.
$sel:iatTTL:OpenIDConnectConfig', openIDConnectConfig_iatTTL - The number of milliseconds that a token is valid after it's issued to a
user.
$sel:issuer:OpenIDConnectConfig', openIDConnectConfig_issuer - The issuer for the OIDC configuration. The issuer returned by discovery
must exactly match the value of iss in the ID token.
openIDConnectConfig_authTTL :: Lens' OpenIDConnectConfig (Maybe Integer) Source #
The number of milliseconds that a token is valid after being authenticated.
openIDConnectConfig_clientId :: Lens' OpenIDConnectConfig (Maybe Text) Source #
The client identifier of the relying party at the OpenID identity provider. This identifier is typically obtained when the relying party is registered with the OpenID identity provider. You can specify a regular expression so that AppSync can validate against multiple client identifiers at a time.
openIDConnectConfig_iatTTL :: Lens' OpenIDConnectConfig (Maybe Integer) Source #
The number of milliseconds that a token is valid after it's issued to a user.
openIDConnectConfig_issuer :: Lens' OpenIDConnectConfig Text Source #
The issuer for the OIDC configuration. The issuer returned by discovery
must exactly match the value of iss in the ID token.
OpenSearchServiceDataSourceConfig
data OpenSearchServiceDataSourceConfig Source #
Describes an OpenSearch data source configuration.
See: newOpenSearchServiceDataSourceConfig smart constructor.
Constructors
| OpenSearchServiceDataSourceConfig' | |
Instances
newOpenSearchServiceDataSourceConfig Source #
Arguments
| :: Text | |
| -> Text | |
| -> OpenSearchServiceDataSourceConfig |
Create a value of OpenSearchServiceDataSourceConfig 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:endpoint:OpenSearchServiceDataSourceConfig', openSearchServiceDataSourceConfig_endpoint - The endpoint.
$sel:awsRegion:OpenSearchServiceDataSourceConfig', openSearchServiceDataSourceConfig_awsRegion - The Amazon Web Services Region.
openSearchServiceDataSourceConfig_endpoint :: Lens' OpenSearchServiceDataSourceConfig Text Source #
The endpoint.
openSearchServiceDataSourceConfig_awsRegion :: Lens' OpenSearchServiceDataSourceConfig Text Source #
The Amazon Web Services Region.
PipelineConfig
data PipelineConfig Source #
The pipeline configuration for a resolver of kind PIPELINE.
See: newPipelineConfig smart constructor.
Constructors
| PipelineConfig' | |
Instances
newPipelineConfig :: PipelineConfig Source #
Create a value of PipelineConfig 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:functions:PipelineConfig', pipelineConfig_functions - A list of Function objects.
pipelineConfig_functions :: Lens' PipelineConfig (Maybe [Text]) Source #
A list of Function objects.
RdsHttpEndpointConfig
data RdsHttpEndpointConfig Source #
The Amazon Relational Database Service (Amazon RDS) HTTP endpoint configuration.
See: newRdsHttpEndpointConfig smart constructor.
Constructors
| RdsHttpEndpointConfig' | |
Fields
| |
Instances
newRdsHttpEndpointConfig :: RdsHttpEndpointConfig Source #
Create a value of RdsHttpEndpointConfig 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:awsRegion:RdsHttpEndpointConfig', rdsHttpEndpointConfig_awsRegion - Amazon Web Services Region for Amazon RDS HTTP endpoint.
$sel:awsSecretStoreArn:RdsHttpEndpointConfig', rdsHttpEndpointConfig_awsSecretStoreArn - Amazon Web Services secret store Amazon Resource Name (ARN) for database
credentials.
$sel:databaseName:RdsHttpEndpointConfig', rdsHttpEndpointConfig_databaseName - Logical database name.
$sel:dbClusterIdentifier:RdsHttpEndpointConfig', rdsHttpEndpointConfig_dbClusterIdentifier - Amazon RDS cluster Amazon Resource Name (ARN).
$sel:schema:RdsHttpEndpointConfig', rdsHttpEndpointConfig_schema - Logical schema name.
rdsHttpEndpointConfig_awsRegion :: Lens' RdsHttpEndpointConfig (Maybe Text) Source #
Amazon Web Services Region for Amazon RDS HTTP endpoint.
rdsHttpEndpointConfig_awsSecretStoreArn :: Lens' RdsHttpEndpointConfig (Maybe Text) Source #
Amazon Web Services secret store Amazon Resource Name (ARN) for database credentials.
rdsHttpEndpointConfig_databaseName :: Lens' RdsHttpEndpointConfig (Maybe Text) Source #
Logical database name.
rdsHttpEndpointConfig_dbClusterIdentifier :: Lens' RdsHttpEndpointConfig (Maybe Text) Source #
Amazon RDS cluster Amazon Resource Name (ARN).
rdsHttpEndpointConfig_schema :: Lens' RdsHttpEndpointConfig (Maybe Text) Source #
Logical schema name.
RelationalDatabaseDataSourceConfig
data RelationalDatabaseDataSourceConfig Source #
Describes a relational database data source configuration.
See: newRelationalDatabaseDataSourceConfig smart constructor.
Constructors
| RelationalDatabaseDataSourceConfig' | |
Fields
| |
Instances
newRelationalDatabaseDataSourceConfig :: RelationalDatabaseDataSourceConfig Source #
Create a value of RelationalDatabaseDataSourceConfig 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:rdsHttpEndpointConfig:RelationalDatabaseDataSourceConfig', relationalDatabaseDataSourceConfig_rdsHttpEndpointConfig - Amazon RDS HTTP endpoint settings.
$sel:relationalDatabaseSourceType:RelationalDatabaseDataSourceConfig', relationalDatabaseDataSourceConfig_relationalDatabaseSourceType - Source type for the relational database.
- RDS_HTTP_ENDPOINT: The relational database source type is an Amazon Relational Database Service (Amazon RDS) HTTP endpoint.
relationalDatabaseDataSourceConfig_rdsHttpEndpointConfig :: Lens' RelationalDatabaseDataSourceConfig (Maybe RdsHttpEndpointConfig) Source #
Amazon RDS HTTP endpoint settings.
relationalDatabaseDataSourceConfig_relationalDatabaseSourceType :: Lens' RelationalDatabaseDataSourceConfig (Maybe RelationalDatabaseSourceType) Source #
Source type for the relational database.
- RDS_HTTP_ENDPOINT: The relational database source type is an Amazon Relational Database Service (Amazon RDS) HTTP endpoint.
Resolver
Describes a resolver.
See: newResolver smart constructor.
Constructors
| Resolver' | |
Fields
| |
Instances
newResolver :: Resolver Source #
Create a value of Resolver 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:cachingConfig:Resolver', resolver_cachingConfig - The caching configuration for the resolver.
$sel:code:Resolver', resolver_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.
$sel:dataSourceName:Resolver', resolver_dataSourceName - The resolver data source name.
$sel:fieldName:Resolver', resolver_fieldName - The resolver field name.
$sel:kind:Resolver', resolver_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
Functionobjects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.
$sel:maxBatchSize:Resolver', resolver_maxBatchSize - The maximum batching size for a resolver.
$sel:pipelineConfig:Resolver', resolver_pipelineConfig - The PipelineConfig.
$sel:requestMappingTemplate:Resolver', resolver_requestMappingTemplate - The request mapping template.
$sel:resolverArn:Resolver', resolver_resolverArn - The resolver Amazon Resource Name (ARN).
$sel:responseMappingTemplate:Resolver', resolver_responseMappingTemplate - The response mapping template.
$sel:runtime:Resolver', resolver_runtime - Undocumented member.
$sel:syncConfig:Resolver', resolver_syncConfig - The SyncConfig for a resolver attached to a versioned data source.
$sel:typeName:Resolver', resolver_typeName - The resolver type name.
resolver_cachingConfig :: Lens' Resolver (Maybe CachingConfig) Source #
The caching configuration for the resolver.
resolver_code :: Lens' Resolver (Maybe Text) Source #
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.
resolver_kind :: Lens' Resolver (Maybe ResolverKind) Source #
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
Functionobjects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.
resolver_maxBatchSize :: Lens' Resolver (Maybe Natural) Source #
The maximum batching size for a resolver.
resolver_pipelineConfig :: Lens' Resolver (Maybe PipelineConfig) Source #
The PipelineConfig.
resolver_requestMappingTemplate :: Lens' Resolver (Maybe Text) Source #
The request mapping template.
resolver_resolverArn :: Lens' Resolver (Maybe Text) Source #
The resolver Amazon Resource Name (ARN).
resolver_responseMappingTemplate :: Lens' Resolver (Maybe Text) Source #
The response mapping template.
resolver_runtime :: Lens' Resolver (Maybe AppSyncRuntime) Source #
Undocumented member.
resolver_syncConfig :: Lens' Resolver (Maybe SyncConfig) Source #
The SyncConfig for a resolver attached to a versioned data source.
SyncConfig
data SyncConfig Source #
Describes a Sync configuration for a resolver.
Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.
See: newSyncConfig smart constructor.
Constructors
| SyncConfig' | |
Fields
| |
Instances
newSyncConfig :: SyncConfig Source #
Create a value of SyncConfig 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:conflictDetection:SyncConfig', syncConfig_conflictDetection - The Conflict Detection strategy to use.
- VERSION: Detect conflicts based on object versions for this resolver.
- NONE: Do not detect conflicts when invoking this resolver.
$sel:conflictHandler:SyncConfig', syncConfig_conflictHandler - The Conflict Resolution strategy to perform in the event of a conflict.
- OPTIMISTIC_CONCURRENCY: Resolve conflicts by rejecting mutations when versions don't match the latest version at the server.
- AUTOMERGE: Resolve conflicts with the Automerge conflict resolution strategy.
- LAMBDA: Resolve conflicts with an Lambda function supplied in
the
LambdaConflictHandlerConfig.
$sel:lambdaConflictHandlerConfig:SyncConfig', syncConfig_lambdaConflictHandlerConfig - The LambdaConflictHandlerConfig when configuring LAMBDA as the
Conflict Handler.
syncConfig_conflictDetection :: Lens' SyncConfig (Maybe ConflictDetectionType) Source #
The Conflict Detection strategy to use.
- VERSION: Detect conflicts based on object versions for this resolver.
- NONE: Do not detect conflicts when invoking this resolver.
syncConfig_conflictHandler :: Lens' SyncConfig (Maybe ConflictHandlerType) Source #
The Conflict Resolution strategy to perform in the event of a conflict.
- OPTIMISTIC_CONCURRENCY: Resolve conflicts by rejecting mutations when versions don't match the latest version at the server.
- AUTOMERGE: Resolve conflicts with the Automerge conflict resolution strategy.
- LAMBDA: Resolve conflicts with an Lambda function supplied in
the
LambdaConflictHandlerConfig.
syncConfig_lambdaConflictHandlerConfig :: Lens' SyncConfig (Maybe LambdaConflictHandlerConfig) Source #
The LambdaConflictHandlerConfig when configuring LAMBDA as the
Conflict Handler.
Type
Describes a type.
See: newType smart constructor.
Constructors
| Type' | |
Fields
| |
Instances
Create a value of Type 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:arn:Type', type_arn - The type Amazon Resource Name (ARN).
$sel:definition:Type', type_definition - The type definition.
$sel:description:Type', type_description - The type description.
$sel:format:Type', type_format - The type format: SDL or JSON.
$sel:name:Type', type_name - The type name.
type_format :: Lens' Type (Maybe TypeDefinitionFormat) Source #
The type format: SDL or JSON.
UserPoolConfig
data UserPoolConfig Source #
Describes an Amazon Cognito user pool configuration.
See: newUserPoolConfig smart constructor.
Constructors
| UserPoolConfig' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DefaultAction | |
| -> UserPoolConfig |
Create a value of UserPoolConfig 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:appIdClientRegex:UserPoolConfig', userPoolConfig_appIdClientRegex - A regular expression for validating the incoming Amazon Cognito user
pool app client ID. If this value isn't set, no filtering is applied.
$sel:userPoolId:UserPoolConfig', userPoolConfig_userPoolId - The user pool ID.
$sel:awsRegion:UserPoolConfig', userPoolConfig_awsRegion - The Amazon Web Services Region in which the user pool was created.
$sel:defaultAction:UserPoolConfig', userPoolConfig_defaultAction - The action that you want your GraphQL API to take when a request that
uses Amazon Cognito user pool authentication doesn't match the Amazon
Cognito user pool configuration.
userPoolConfig_appIdClientRegex :: Lens' UserPoolConfig (Maybe Text) Source #
A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied.
userPoolConfig_userPoolId :: Lens' UserPoolConfig Text Source #
The user pool ID.
userPoolConfig_awsRegion :: Lens' UserPoolConfig Text Source #
The Amazon Web Services Region in which the user pool was created.
userPoolConfig_defaultAction :: Lens' UserPoolConfig DefaultAction Source #
The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration.