| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.AppSync.Types
Contents
- Service Configuration
- Errors
- ApiCacheStatus
- ApiCacheType
- ApiCachingBehavior
- AuthenticationType
- AuthorizationType
- ConflictDetectionType
- ConflictHandlerType
- DataSourceType
- DefaultAction
- FieldLogLevel
- OutputType
- RelationalDatabaseSourceType
- ResolverKind
- SchemaStatus
- TypeDefinitionFormat
- AdditionalAuthenticationProvider
- ApiCache
- ApiKey
- AuthorizationConfig
- AwsIamConfig
- CachingConfig
- CognitoUserPoolConfig
- DataSource
- DeltaSyncConfig
- DynamodbDataSourceConfig
- ElasticsearchDataSourceConfig
- FunctionConfiguration
- GraphqlApi
- HttpDataSourceConfig
- LambdaAuthorizerConfig
- LambdaConflictHandlerConfig
- LambdaDataSourceConfig
- LogConfig
- OpenIDConnectConfig
- OpenSearchServiceDataSourceConfig
- PipelineConfig
- RdsHttpEndpointConfig
- RelationalDatabaseDataSourceConfig
- Resolver
- SyncConfig
- Type
- UserPoolConfig
Description
Synopsis
- defaultService :: Service
- _ApiKeyValidityOutOfBoundsException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ApiKeyLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ApiLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _GraphQLSchemaException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalFailureException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnauthorizedException :: AsError a => Getting (First ServiceError) a ServiceError
- _BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) 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 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 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_openIDConnectConfig :: Lens' AdditionalAuthenticationProvider (Maybe OpenIDConnectConfig)
- additionalAuthenticationProvider_lambdaAuthorizerConfig :: Lens' AdditionalAuthenticationProvider (Maybe LambdaAuthorizerConfig)
- additionalAuthenticationProvider_userPoolConfig :: Lens' AdditionalAuthenticationProvider (Maybe CognitoUserPoolConfig)
- additionalAuthenticationProvider_authenticationType :: Lens' AdditionalAuthenticationProvider (Maybe AuthenticationType)
- data ApiCache = ApiCache' {}
- newApiCache :: ApiCache
- apiCache_ttl :: Lens' ApiCache (Maybe Integer)
- apiCache_status :: Lens' ApiCache (Maybe ApiCacheStatus)
- apiCache_atRestEncryptionEnabled :: Lens' ApiCache (Maybe Bool)
- apiCache_transitEncryptionEnabled :: Lens' ApiCache (Maybe Bool)
- apiCache_apiCachingBehavior :: Lens' ApiCache (Maybe ApiCachingBehavior)
- apiCache_type :: Lens' ApiCache (Maybe ApiCacheType)
- data ApiKey = ApiKey' {}
- newApiKey :: ApiKey
- apiKey_expires :: Lens' ApiKey (Maybe Integer)
- apiKey_deletes :: Lens' ApiKey (Maybe Integer)
- apiKey_id :: Lens' ApiKey (Maybe Text)
- apiKey_description :: Lens' ApiKey (Maybe Text)
- data AuthorizationConfig = AuthorizationConfig' {}
- newAuthorizationConfig :: AuthorizationType -> AuthorizationConfig
- authorizationConfig_awsIamConfig :: Lens' AuthorizationConfig (Maybe AwsIamConfig)
- authorizationConfig_authorizationType :: Lens' AuthorizationConfig AuthorizationType
- data AwsIamConfig = AwsIamConfig' {}
- newAwsIamConfig :: AwsIamConfig
- awsIamConfig_signingServiceName :: Lens' AwsIamConfig (Maybe Text)
- awsIamConfig_signingRegion :: Lens' AwsIamConfig (Maybe Text)
- data CachingConfig = CachingConfig' {}
- newCachingConfig :: CachingConfig
- cachingConfig_ttl :: Lens' CachingConfig (Maybe Integer)
- cachingConfig_cachingKeys :: Lens' CachingConfig (Maybe [Text])
- 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' {
- serviceRoleArn :: Maybe Text
- relationalDatabaseConfig :: Maybe RelationalDatabaseDataSourceConfig
- dataSourceArn :: Maybe Text
- dynamodbConfig :: Maybe DynamodbDataSourceConfig
- name :: Maybe Text
- httpConfig :: Maybe HttpDataSourceConfig
- openSearchServiceConfig :: Maybe OpenSearchServiceDataSourceConfig
- lambdaConfig :: Maybe LambdaDataSourceConfig
- type' :: Maybe DataSourceType
- description :: Maybe Text
- elasticsearchConfig :: Maybe ElasticsearchDataSourceConfig
- newDataSource :: DataSource
- dataSource_serviceRoleArn :: Lens' DataSource (Maybe Text)
- dataSource_relationalDatabaseConfig :: Lens' DataSource (Maybe RelationalDatabaseDataSourceConfig)
- dataSource_dataSourceArn :: Lens' DataSource (Maybe Text)
- dataSource_dynamodbConfig :: Lens' DataSource (Maybe DynamodbDataSourceConfig)
- dataSource_name :: Lens' DataSource (Maybe Text)
- dataSource_httpConfig :: Lens' DataSource (Maybe HttpDataSourceConfig)
- dataSource_openSearchServiceConfig :: Lens' DataSource (Maybe OpenSearchServiceDataSourceConfig)
- dataSource_lambdaConfig :: Lens' DataSource (Maybe LambdaDataSourceConfig)
- dataSource_type :: Lens' DataSource (Maybe DataSourceType)
- dataSource_description :: Lens' DataSource (Maybe Text)
- dataSource_elasticsearchConfig :: Lens' DataSource (Maybe ElasticsearchDataSourceConfig)
- data DeltaSyncConfig = DeltaSyncConfig' {}
- newDeltaSyncConfig :: DeltaSyncConfig
- deltaSyncConfig_baseTableTTL :: Lens' DeltaSyncConfig (Maybe Integer)
- deltaSyncConfig_deltaSyncTableName :: Lens' DeltaSyncConfig (Maybe Text)
- deltaSyncConfig_deltaSyncTableTTL :: Lens' DeltaSyncConfig (Maybe Integer)
- data DynamodbDataSourceConfig = DynamodbDataSourceConfig' {}
- newDynamodbDataSourceConfig :: Text -> Text -> DynamodbDataSourceConfig
- dynamodbDataSourceConfig_versioned :: Lens' DynamodbDataSourceConfig (Maybe Bool)
- dynamodbDataSourceConfig_useCallerCredentials :: Lens' DynamodbDataSourceConfig (Maybe Bool)
- dynamodbDataSourceConfig_deltaSyncConfig :: Lens' DynamodbDataSourceConfig (Maybe DeltaSyncConfig)
- 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 FunctionConfiguration = FunctionConfiguration' {}
- newFunctionConfiguration :: FunctionConfiguration
- functionConfiguration_functionArn :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_dataSourceName :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_requestMappingTemplate :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_name :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_functionId :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_responseMappingTemplate :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_syncConfig :: Lens' FunctionConfiguration (Maybe SyncConfig)
- functionConfiguration_functionVersion :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_description :: Lens' FunctionConfiguration (Maybe Text)
- data GraphqlApi = GraphqlApi' {
- xrayEnabled :: Maybe Bool
- arn :: Maybe Text
- apiId :: Maybe Text
- uris :: Maybe (HashMap Text Text)
- openIDConnectConfig :: Maybe OpenIDConnectConfig
- wafWebAclArn :: Maybe Text
- additionalAuthenticationProviders :: Maybe [AdditionalAuthenticationProvider]
- lambdaAuthorizerConfig :: Maybe LambdaAuthorizerConfig
- name :: Maybe Text
- userPoolConfig :: Maybe UserPoolConfig
- authenticationType :: Maybe AuthenticationType
- logConfig :: Maybe LogConfig
- tags :: Maybe (HashMap Text Text)
- newGraphqlApi :: GraphqlApi
- graphqlApi_xrayEnabled :: Lens' GraphqlApi (Maybe Bool)
- graphqlApi_arn :: Lens' GraphqlApi (Maybe Text)
- graphqlApi_apiId :: Lens' GraphqlApi (Maybe Text)
- graphqlApi_uris :: Lens' GraphqlApi (Maybe (HashMap Text Text))
- graphqlApi_openIDConnectConfig :: Lens' GraphqlApi (Maybe OpenIDConnectConfig)
- graphqlApi_wafWebAclArn :: Lens' GraphqlApi (Maybe Text)
- graphqlApi_additionalAuthenticationProviders :: Lens' GraphqlApi (Maybe [AdditionalAuthenticationProvider])
- graphqlApi_lambdaAuthorizerConfig :: Lens' GraphqlApi (Maybe LambdaAuthorizerConfig)
- graphqlApi_name :: Lens' GraphqlApi (Maybe Text)
- graphqlApi_userPoolConfig :: Lens' GraphqlApi (Maybe UserPoolConfig)
- graphqlApi_authenticationType :: Lens' GraphqlApi (Maybe AuthenticationType)
- graphqlApi_logConfig :: Lens' GraphqlApi (Maybe LogConfig)
- graphqlApi_tags :: Lens' GraphqlApi (Maybe (HashMap Text Text))
- data HttpDataSourceConfig = HttpDataSourceConfig' {}
- newHttpDataSourceConfig :: HttpDataSourceConfig
- httpDataSourceConfig_authorizationConfig :: Lens' HttpDataSourceConfig (Maybe AuthorizationConfig)
- httpDataSourceConfig_endpoint :: Lens' HttpDataSourceConfig (Maybe Text)
- data LambdaAuthorizerConfig = LambdaAuthorizerConfig' {}
- newLambdaAuthorizerConfig :: Text -> LambdaAuthorizerConfig
- lambdaAuthorizerConfig_identityValidationExpression :: Lens' LambdaAuthorizerConfig (Maybe Text)
- lambdaAuthorizerConfig_authorizerResultTtlInSeconds :: Lens' LambdaAuthorizerConfig (Maybe Natural)
- 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_dbClusterIdentifier :: Lens' RdsHttpEndpointConfig (Maybe Text)
- rdsHttpEndpointConfig_schema :: Lens' RdsHttpEndpointConfig (Maybe Text)
- rdsHttpEndpointConfig_databaseName :: Lens' RdsHttpEndpointConfig (Maybe Text)
- rdsHttpEndpointConfig_awsRegion :: Lens' RdsHttpEndpointConfig (Maybe Text)
- rdsHttpEndpointConfig_awsSecretStoreArn :: Lens' RdsHttpEndpointConfig (Maybe Text)
- data RelationalDatabaseDataSourceConfig = RelationalDatabaseDataSourceConfig' {}
- newRelationalDatabaseDataSourceConfig :: RelationalDatabaseDataSourceConfig
- relationalDatabaseDataSourceConfig_relationalDatabaseSourceType :: Lens' RelationalDatabaseDataSourceConfig (Maybe RelationalDatabaseSourceType)
- relationalDatabaseDataSourceConfig_rdsHttpEndpointConfig :: Lens' RelationalDatabaseDataSourceConfig (Maybe RdsHttpEndpointConfig)
- data Resolver = Resolver' {
- typeName :: Maybe Text
- dataSourceName :: Maybe Text
- requestMappingTemplate :: Maybe Text
- kind :: Maybe ResolverKind
- resolverArn :: Maybe Text
- cachingConfig :: Maybe CachingConfig
- responseMappingTemplate :: Maybe Text
- fieldName :: Maybe Text
- syncConfig :: Maybe SyncConfig
- pipelineConfig :: Maybe PipelineConfig
- newResolver :: Resolver
- resolver_typeName :: Lens' Resolver (Maybe Text)
- resolver_dataSourceName :: Lens' Resolver (Maybe Text)
- resolver_requestMappingTemplate :: Lens' Resolver (Maybe Text)
- resolver_kind :: Lens' Resolver (Maybe ResolverKind)
- resolver_resolverArn :: Lens' Resolver (Maybe Text)
- resolver_cachingConfig :: Lens' Resolver (Maybe CachingConfig)
- resolver_responseMappingTemplate :: Lens' Resolver (Maybe Text)
- resolver_fieldName :: Lens' Resolver (Maybe Text)
- resolver_syncConfig :: Lens' Resolver (Maybe SyncConfig)
- resolver_pipelineConfig :: Lens' Resolver (Maybe PipelineConfig)
- data SyncConfig = SyncConfig' {}
- newSyncConfig :: SyncConfig
- syncConfig_conflictHandler :: Lens' SyncConfig (Maybe ConflictHandlerType)
- syncConfig_conflictDetection :: Lens' SyncConfig (Maybe ConflictDetectionType)
- syncConfig_lambdaConflictHandlerConfig :: Lens' SyncConfig (Maybe LambdaConflictHandlerConfig)
- data Type = Type' {
- arn :: Maybe Text
- definition :: Maybe Text
- format :: Maybe TypeDefinitionFormat
- name :: Maybe Text
- description :: Maybe Text
- newType :: Type
- type_arn :: Lens' Type (Maybe Text)
- type_definition :: Lens' Type (Maybe Text)
- type_format :: Lens' Type (Maybe TypeDefinitionFormat)
- type_name :: Lens' Type (Maybe Text)
- type_description :: 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
_ApiKeyValidityOutOfBoundsException :: AsError a => Getting (First ServiceError) 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).
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You do not have access to perform this operation on this resource.
_ApiKeyLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The API key exceeded a limit. Try your request again.
_ApiLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The GraphQL API exceeded a limit. Try your request again.
_NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource specified in the request was not found. Check the resource, and then try again.
_GraphQLSchemaException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The GraphQL schema is not valid.
_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Another modification is in progress at this time and it must complete before you can make your change.
_InternalFailureException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An internal AppSync error occurred. Try your request again.
_UnauthorizedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You are not authorized to perform this operation.
_BadRequestException :: AsError a => Getting (First ServiceError) 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.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request exceeded a limit. Try your request again.
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
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
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:openIDConnectConfig:AdditionalAuthenticationProvider', additionalAuthenticationProvider_openIDConnectConfig - The OpenID Connect configuration.
$sel:lambdaAuthorizerConfig:AdditionalAuthenticationProvider', additionalAuthenticationProvider_lambdaAuthorizerConfig - Configuration for Amazon Web Services Lambda function authorization.
$sel:userPoolConfig:AdditionalAuthenticationProvider', additionalAuthenticationProvider_userPoolConfig - The Amazon Cognito user pool configuration.
$sel:authenticationType:AdditionalAuthenticationProvider', additionalAuthenticationProvider_authenticationType - The authentication type: API key, Identity and Access Management, OIDC,
Amazon Cognito user pools, or Amazon Web Services Lambda.
additionalAuthenticationProvider_openIDConnectConfig :: Lens' AdditionalAuthenticationProvider (Maybe OpenIDConnectConfig) Source #
The OpenID Connect configuration.
additionalAuthenticationProvider_lambdaAuthorizerConfig :: Lens' AdditionalAuthenticationProvider (Maybe LambdaAuthorizerConfig) Source #
Configuration for Amazon Web Services Lambda function authorization.
additionalAuthenticationProvider_userPoolConfig :: Lens' AdditionalAuthenticationProvider (Maybe CognitoUserPoolConfig) Source #
The Amazon Cognito user pool configuration.
additionalAuthenticationProvider_authenticationType :: Lens' AdditionalAuthenticationProvider (Maybe AuthenticationType) Source #
The authentication type: API key, Identity and Access Management, OIDC, Amazon Cognito user pools, or Amazon Web Services Lambda.
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:ttl:ApiCache', apiCache_ttl - TTL in seconds for cache entries.
Valid values are between 1 and 3600 seconds.
$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:atRestEncryptionEnabled:ApiCache', apiCache_atRestEncryptionEnabled - At rest encryption flag for cache. This setting cannot be updated after
creation.
$sel:transitEncryptionEnabled:ApiCache', apiCache_transitEncryptionEnabled - Transit encryption flag when connecting to cache. This setting cannot be
updated after creation.
$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: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_ttl :: Lens' ApiCache (Maybe Integer) Source #
TTL in seconds for cache entries.
Valid values are between 1 and 3600 seconds.
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_atRestEncryptionEnabled :: Lens' ApiCache (Maybe Bool) Source #
At rest encryption flag for cache. This setting cannot be updated after creation.
apiCache_transitEncryptionEnabled :: Lens' ApiCache (Maybe Bool) Source #
Transit encryption flag when connecting to cache. This setting cannot be updated after creation.
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_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: This version was introduced at launch in November 2017. These keys always expire after 7 days. Key expiration is managed by Amazon DynamoDB TTL. The keys ceased to be valid after February 21, 2018 and should not be used after that date.
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 Amazon 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 will delete these keys from the table after February 21, 2018.
da2: This version was introduced 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. Key expiration time can be updated while the key is not deleted.DeleteApiKeydeletes the item from the table.- Expiration is stored in Amazon DynamoDB as seconds. After the expiration time, using the key to authenticate will fail. But the key can be reinstated before deletion.
- Deletion is stored in Amazon DynamoDB as seconds. The key will be deleted after deletion time.
See: newApiKey smart constructor.
Constructors
| ApiKey' | |
Fields
| |
Instances
| Eq ApiKey Source # | |
| Read ApiKey Source # | |
| Show ApiKey Source # | |
| Generic ApiKey Source # | |
| NFData ApiKey Source # | |
Defined in Amazonka.AppSync.Types.ApiKey | |
| Hashable ApiKey Source # | |
Defined in Amazonka.AppSync.Types.ApiKey | |
| FromJSON ApiKey Source # | |
| type Rep ApiKey Source # | |
Defined in Amazonka.AppSync.Types.ApiKey type Rep ApiKey = D1 ('MetaData "ApiKey" "Amazonka.AppSync.Types.ApiKey" "libZSservicesZSamazonka-appsyncZSamazonka-appsync" 'False) (C1 ('MetaCons "ApiKey'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "expires") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "deletes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") '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: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: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:id:ApiKey', apiKey_id - The API key ID.
$sel:description:ApiKey', apiKey_description - 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.
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.
AuthorizationConfig
data AuthorizationConfig Source #
The authorization config 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 settings.
$sel:authorizationType:AuthorizationConfig', authorizationConfig_authorizationType - The authorization type required by the HTTP endpoint.
- AWS_IAM: The authorization type is Sigv4.
authorizationConfig_awsIamConfig :: Lens' AuthorizationConfig (Maybe AwsIamConfig) Source #
The Identity and Access Management settings.
authorizationConfig_authorizationType :: Lens' AuthorizationConfig AuthorizationType Source #
The authorization type required by the HTTP endpoint.
- AWS_IAM: The authorization type is Sigv4.
AwsIamConfig
data AwsIamConfig Source #
The Identity and Access Management 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:signingServiceName:AwsIamConfig', awsIamConfig_signingServiceName - The signing service name for Identity and Access Management
authorization.
$sel:signingRegion:AwsIamConfig', awsIamConfig_signingRegion - The signing region for Identity and Access Management authorization.
awsIamConfig_signingServiceName :: Lens' AwsIamConfig (Maybe Text) Source #
The signing service name for Identity and Access Management authorization.
awsIamConfig_signingRegion :: Lens' AwsIamConfig (Maybe Text) Source #
The signing region for Identity and Access Management authorization.
CachingConfig
data CachingConfig Source #
The caching configuration for a resolver that has caching enabled.
See: newCachingConfig smart constructor.
Constructors
| CachingConfig' | |
Fields
| |
Instances
newCachingConfig :: CachingConfig Source #
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:ttl:CachingConfig', cachingConfig_ttl - The TTL in seconds for a resolver that has caching enabled.
Valid values are between 1 and 3600 seconds.
$sel:cachingKeys:CachingConfig', cachingConfig_cachingKeys - The caching keys for a resolver that has caching enabled.
Valid values are entries from the $context.arguments,
$context.source, and $context.identity maps.
cachingConfig_ttl :: Lens' CachingConfig (Maybe Integer) Source #
The TTL in seconds for a resolver that has caching enabled.
Valid values are between 1 and 3600 seconds.
cachingConfig_cachingKeys :: Lens' CachingConfig (Maybe [Text]) Source #
The caching keys for a resolver that has caching enabled.
Valid values are entries from the $context.arguments,
$context.source, and $context.identity maps.
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.
$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.
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:serviceRoleArn:DataSource', dataSource_serviceRoleArn - The Identity and Access Management service role ARN for the data source.
The system assumes this role when accessing the data source.
$sel:relationalDatabaseConfig:DataSource', dataSource_relationalDatabaseConfig - Relational database settings.
$sel:dataSourceArn:DataSource', dataSource_dataSourceArn - The data source ARN.
$sel:dynamodbConfig:DataSource', dataSource_dynamodbConfig - Amazon DynamoDB settings.
$sel:name:DataSource', dataSource_name - The name of the data source.
$sel:httpConfig:DataSource', dataSource_httpConfig - HTTP endpoint settings.
$sel:openSearchServiceConfig:DataSource', dataSource_openSearchServiceConfig - Amazon OpenSearch Service settings.
$sel:lambdaConfig:DataSource', dataSource_lambdaConfig - Amazon Web Services Lambda settings.
$sel:type':DataSource', dataSource_type - The type of the data source.
- AWS_LAMBDA: The data source is an Amazon Web Services 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. This type is used when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation.
- HTTP: The data source is an HTTP endpoint.
- RELATIONAL_DATABASE: The data source is a relational database.
$sel:description:DataSource', dataSource_description - The description of the data source.
$sel:elasticsearchConfig:DataSource', dataSource_elasticsearchConfig - Amazon OpenSearch Service settings.
dataSource_serviceRoleArn :: Lens' DataSource (Maybe Text) Source #
The Identity and Access Management service role ARN for the data source. The system assumes this role when accessing the data source.
dataSource_relationalDatabaseConfig :: Lens' DataSource (Maybe RelationalDatabaseDataSourceConfig) Source #
Relational database settings.
dataSource_dataSourceArn :: Lens' DataSource (Maybe Text) Source #
The data source ARN.
dataSource_dynamodbConfig :: Lens' DataSource (Maybe DynamodbDataSourceConfig) Source #
Amazon DynamoDB settings.
dataSource_name :: Lens' DataSource (Maybe Text) Source #
The name of the data source.
dataSource_httpConfig :: Lens' DataSource (Maybe HttpDataSourceConfig) Source #
HTTP endpoint settings.
dataSource_openSearchServiceConfig :: Lens' DataSource (Maybe OpenSearchServiceDataSourceConfig) Source #
Amazon OpenSearch Service settings.
dataSource_lambdaConfig :: Lens' DataSource (Maybe LambdaDataSourceConfig) Source #
Amazon Web Services Lambda settings.
dataSource_type :: Lens' DataSource (Maybe DataSourceType) Source #
The type of the data source.
- AWS_LAMBDA: The data source is an Amazon Web Services 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. This type is used when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation.
- HTTP: The data source is an HTTP endpoint.
- RELATIONAL_DATABASE: The data source is a relational database.
dataSource_description :: Lens' DataSource (Maybe Text) Source #
The description of the data source.
dataSource_elasticsearchConfig :: Lens' DataSource (Maybe ElasticsearchDataSourceConfig) Source #
Amazon OpenSearch Service settings.
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 an Item is stored in the datasource.
$sel:deltaSyncTableName:DeltaSyncConfig', deltaSyncConfig_deltaSyncTableName - The Delta Sync table name.
$sel:deltaSyncTableTTL:DeltaSyncConfig', deltaSyncConfig_deltaSyncTableTTL - The number of minutes a Delta Sync log entry is stored in the Delta Sync
table.
deltaSyncConfig_baseTableTTL :: Lens' DeltaSyncConfig (Maybe Integer) Source #
The number of minutes an Item is stored in the datasource.
deltaSyncConfig_deltaSyncTableName :: Lens' DeltaSyncConfig (Maybe Text) Source #
The Delta Sync table name.
deltaSyncConfig_deltaSyncTableTTL :: Lens' DeltaSyncConfig (Maybe Integer) Source #
The number of minutes a Delta Sync log entry is stored in the Delta Sync table.
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:versioned:DynamodbDataSourceConfig', dynamodbDataSourceConfig_versioned - Set to TRUE to use Conflict Detection and Resolution with this data
source.
$sel:useCallerCredentials:DynamodbDataSourceConfig', dynamodbDataSourceConfig_useCallerCredentials - Set to TRUE to use Amazon Cognito credentials with this data source.
$sel:deltaSyncConfig:DynamodbDataSourceConfig', dynamodbDataSourceConfig_deltaSyncConfig - The DeltaSyncConfig for a versioned datasource.
$sel:tableName:DynamodbDataSourceConfig', dynamodbDataSourceConfig_tableName - The table name.
$sel:awsRegion:DynamodbDataSourceConfig', dynamodbDataSourceConfig_awsRegion - The Amazon Web Services Region.
dynamodbDataSourceConfig_versioned :: Lens' DynamodbDataSourceConfig (Maybe Bool) Source #
Set to TRUE to use Conflict Detection and Resolution with this data source.
dynamodbDataSourceConfig_useCallerCredentials :: Lens' DynamodbDataSourceConfig (Maybe Bool) Source #
Set to TRUE to use Amazon Cognito credentials with this data source.
dynamodbDataSourceConfig_deltaSyncConfig :: Lens' DynamodbDataSourceConfig (Maybe DeltaSyncConfig) Source #
The DeltaSyncConfig for a versioned datasource.
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.
FunctionConfiguration
data FunctionConfiguration Source #
A function is a reusable entity. Multiple functions can be used 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:functionArn:FunctionConfiguration', functionConfiguration_functionArn - The ARN of the Function object.
$sel:dataSourceName:FunctionConfiguration', functionConfiguration_dataSourceName - The name of the DataSource.
$sel:requestMappingTemplate:FunctionConfiguration', functionConfiguration_requestMappingTemplate - The Function request mapping template. Functions support only the
2018-05-29 version of the request mapping template.
$sel:name:FunctionConfiguration', functionConfiguration_name - The name of the Function object.
$sel:functionId:FunctionConfiguration', functionConfiguration_functionId - A unique ID representing the Function object.
$sel:responseMappingTemplate:FunctionConfiguration', functionConfiguration_responseMappingTemplate - The Function response mapping template.
$sel:syncConfig:FunctionConfiguration', functionConfiguration_syncConfig - Undocumented member.
$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:description:FunctionConfiguration', functionConfiguration_description - The Function description.
functionConfiguration_functionArn :: Lens' FunctionConfiguration (Maybe Text) Source #
The ARN of the Function object.
functionConfiguration_dataSourceName :: Lens' FunctionConfiguration (Maybe Text) Source #
The name of the DataSource.
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_name :: Lens' FunctionConfiguration (Maybe Text) Source #
The name of the Function object.
functionConfiguration_functionId :: Lens' FunctionConfiguration (Maybe Text) Source #
A unique ID representing the Function object.
functionConfiguration_responseMappingTemplate :: Lens' FunctionConfiguration (Maybe Text) Source #
The Function response mapping template.
functionConfiguration_syncConfig :: Lens' FunctionConfiguration (Maybe SyncConfig) Source #
Undocumented member.
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_description :: Lens' FunctionConfiguration (Maybe Text) Source #
The Function description.
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:xrayEnabled:GraphqlApi', graphqlApi_xrayEnabled - A flag representing whether X-Ray tracing is enabled for this
GraphqlApi.
$sel:arn:GraphqlApi', graphqlApi_arn - The ARN.
$sel:apiId:GraphqlApi', graphqlApi_apiId - The API ID.
$sel:uris:GraphqlApi', graphqlApi_uris - The URIs.
$sel:openIDConnectConfig:GraphqlApi', graphqlApi_openIDConnectConfig - The OpenID Connect configuration.
$sel:wafWebAclArn:GraphqlApi', graphqlApi_wafWebAclArn - The ARN of the WAF ACL associated with this GraphqlApi, if one exists.
$sel:additionalAuthenticationProviders:GraphqlApi', graphqlApi_additionalAuthenticationProviders - A list of additional authentication providers for the GraphqlApi API.
$sel:lambdaAuthorizerConfig:GraphqlApi', graphqlApi_lambdaAuthorizerConfig - Configuration for Amazon Web Services Lambda function authorization.
$sel:name:GraphqlApi', graphqlApi_name - The API name.
$sel:userPoolConfig:GraphqlApi', graphqlApi_userPoolConfig - The Amazon Cognito user pool configuration.
$sel:authenticationType:GraphqlApi', graphqlApi_authenticationType - The authentication type.
$sel:logConfig:GraphqlApi', graphqlApi_logConfig - The Amazon CloudWatch Logs configuration.
$sel:tags:GraphqlApi', graphqlApi_tags - The tags.
graphqlApi_xrayEnabled :: Lens' GraphqlApi (Maybe Bool) Source #
A flag representing whether X-Ray tracing is enabled for this
GraphqlApi.
graphqlApi_arn :: Lens' GraphqlApi (Maybe Text) Source #
The ARN.
graphqlApi_apiId :: Lens' GraphqlApi (Maybe Text) Source #
The API ID.
graphqlApi_uris :: Lens' GraphqlApi (Maybe (HashMap Text Text)) Source #
The URIs.
graphqlApi_openIDConnectConfig :: Lens' GraphqlApi (Maybe OpenIDConnectConfig) Source #
The OpenID Connect configuration.
graphqlApi_wafWebAclArn :: Lens' GraphqlApi (Maybe Text) Source #
The ARN of the WAF ACL associated with this GraphqlApi, if one exists.
graphqlApi_additionalAuthenticationProviders :: Lens' GraphqlApi (Maybe [AdditionalAuthenticationProvider]) Source #
A list of additional authentication providers for the GraphqlApi API.
graphqlApi_lambdaAuthorizerConfig :: Lens' GraphqlApi (Maybe LambdaAuthorizerConfig) Source #
Configuration for Amazon Web Services Lambda function authorization.
graphqlApi_name :: Lens' GraphqlApi (Maybe Text) Source #
The API name.
graphqlApi_userPoolConfig :: Lens' GraphqlApi (Maybe UserPoolConfig) Source #
The Amazon Cognito user pool configuration.
graphqlApi_authenticationType :: Lens' GraphqlApi (Maybe AuthenticationType) Source #
The authentication type.
graphqlApi_logConfig :: Lens' GraphqlApi (Maybe LogConfig) Source #
The Amazon CloudWatch Logs configuration.
graphqlApi_tags :: Lens' GraphqlApi (Maybe (HashMap Text Text)) Source #
The tags.
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 config in case the HTTP endpoint requires
authorization.
$sel:endpoint:HttpDataSourceConfig', httpDataSourceConfig_endpoint - The HTTP URL endpoint. You can either specify the domain name or IP, and
port combination, and the URL scheme must be HTTP or HTTPS. If the port
is not specified, 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 config in case the HTTP endpoint requires authorization.
httpDataSourceConfig_endpoint :: Lens' HttpDataSourceConfig (Maybe Text) Source #
The HTTP URL endpoint. You can either specify the domain name or IP, and port combination, and the URL scheme must be HTTP or HTTPS. If the port is not specified, AppSync uses the default port 80 for the HTTP endpoint and port 443 for HTTPS endpoints.
LambdaAuthorizerConfig
data LambdaAuthorizerConfig Source #
A LambdaAuthorizerConfig holds configuration on how to authorize
AppSync API access when using the AWS_LAMBDA authorizer mode. Be aware
that an AppSync API may 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:identityValidationExpression:LambdaAuthorizerConfig', lambdaAuthorizerConfig_identityValidationExpression - A regular expression for validation of tokens before the Lambda function
is called.
$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:authorizerUri:LambdaAuthorizerConfig', lambdaAuthorizerConfig_authorizerUri - The ARN of the Lambda function to be called for authorization. This may
be a standard Lambda ARN, a version ARN (.../v3) or 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 do so with the Amazon Web Services 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_identityValidationExpression :: Lens' LambdaAuthorizerConfig (Maybe Text) Source #
A regular expression for validation of tokens before the Lambda function is called.
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_authorizerUri :: Lens' LambdaAuthorizerConfig Text Source #
The ARN of the Lambda function to be called for authorization. This may
be a standard Lambda ARN, a version ARN (.../v3) or 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 do so with the Amazon Web Services 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 Arn for the Lambda function to use as the Conflict Handler.
lambdaConflictHandlerConfig_lambdaConflictHandlerArn :: Lens' LambdaConflictHandlerConfig (Maybe Text) Source #
The Arn for the Lambda function to use as the Conflict Handler.
LambdaDataSourceConfig
data LambdaDataSourceConfig Source #
Describes an Amazon Web Services 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 ARN for the Lambda function.
lambdaDataSourceConfig_lambdaFunctionArn :: Lens' LambdaDataSourceConfig Text Source #
The ARN for the Lambda function.
LogConfig
The CloudWatch Logs configuration.
See: newLogConfig smart constructor.
Constructors
| LogConfig' | |
Fields
| |
Instances
| Eq LogConfig Source # | |
| Read LogConfig Source # | |
| Show LogConfig Source # | |
| Generic LogConfig Source # | |
| NFData LogConfig Source # | |
Defined in Amazonka.AppSync.Types.LogConfig | |
| Hashable LogConfig Source # | |
Defined in Amazonka.AppSync.Types.LogConfig | |
| ToJSON LogConfig Source # | |
Defined in Amazonka.AppSync.Types.LogConfig | |
| FromJSON LogConfig Source # | |
| type Rep LogConfig Source # | |
Defined in Amazonka.AppSync.Types.LogConfig type Rep LogConfig = D1 ('MetaData "LogConfig" "Amazonka.AppSync.Types.LogConfig" "libZSservicesZSamazonka-appsyncZSamazonka-appsync" '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 will assume to publish to Amazon
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 will assume to publish to Amazon CloudWatch logs in your account.
OpenIDConnectConfig
data OpenIDConnectConfig Source #
Describes an OpenID Connect 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 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 the AppSync can validate against multiple client
identifiers at a time.
$sel:iatTTL:OpenIDConnectConfig', openIDConnectConfig_iatTTL - The number of milliseconds a token is valid after being issued to a
user.
$sel:issuer:OpenIDConnectConfig', openIDConnectConfig_issuer - The issuer for the OpenID Connect 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 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 the AppSync can validate against multiple client identifiers at a time.
openIDConnectConfig_iatTTL :: Lens' OpenIDConnectConfig (Maybe Integer) Source #
The number of milliseconds a token is valid after being issued to a user.
openIDConnectConfig_issuer :: Lens' OpenIDConnectConfig Text Source #
The issuer for the OpenID Connect 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 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:dbClusterIdentifier:RdsHttpEndpointConfig', rdsHttpEndpointConfig_dbClusterIdentifier - Amazon RDS cluster ARN.
$sel:schema:RdsHttpEndpointConfig', rdsHttpEndpointConfig_schema - Logical schema name.
$sel:databaseName:RdsHttpEndpointConfig', rdsHttpEndpointConfig_databaseName - Logical database name.
$sel:awsRegion:RdsHttpEndpointConfig', rdsHttpEndpointConfig_awsRegion - Amazon Web Services Region for RDS HTTP endpoint.
$sel:awsSecretStoreArn:RdsHttpEndpointConfig', rdsHttpEndpointConfig_awsSecretStoreArn - Amazon Web Services secret store ARN for database credentials.
rdsHttpEndpointConfig_dbClusterIdentifier :: Lens' RdsHttpEndpointConfig (Maybe Text) Source #
Amazon RDS cluster ARN.
rdsHttpEndpointConfig_schema :: Lens' RdsHttpEndpointConfig (Maybe Text) Source #
Logical schema name.
rdsHttpEndpointConfig_databaseName :: Lens' RdsHttpEndpointConfig (Maybe Text) Source #
Logical database name.
rdsHttpEndpointConfig_awsRegion :: Lens' RdsHttpEndpointConfig (Maybe Text) Source #
Amazon Web Services Region for RDS HTTP endpoint.
rdsHttpEndpointConfig_awsSecretStoreArn :: Lens' RdsHttpEndpointConfig (Maybe Text) Source #
Amazon Web Services secret store ARN for database credentials.
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:relationalDatabaseSourceType:RelationalDatabaseDataSourceConfig', relationalDatabaseDataSourceConfig_relationalDatabaseSourceType - Source type for the relational database.
- RDS_HTTP_ENDPOINT: The relational database source type is an Amazon RDS HTTP endpoint.
$sel:rdsHttpEndpointConfig:RelationalDatabaseDataSourceConfig', relationalDatabaseDataSourceConfig_rdsHttpEndpointConfig - 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 RDS HTTP endpoint.
relationalDatabaseDataSourceConfig_rdsHttpEndpointConfig :: Lens' RelationalDatabaseDataSourceConfig (Maybe RdsHttpEndpointConfig) Source #
Amazon RDS HTTP endpoint settings.
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:typeName:Resolver', resolver_typeName - The resolver type name.
$sel:dataSourceName:Resolver', resolver_dataSourceName - The resolver data source name.
$sel:requestMappingTemplate:Resolver', resolver_requestMappingTemplate - The request mapping template.
$sel:kind:Resolver', resolver_kind - The resolver type.
- UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source.
- PIPELINE: A PIPELINE resolver type. A PIPELINE resolver enables
you to execute a series of
Functionin a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.
$sel:resolverArn:Resolver', resolver_resolverArn - The resolver ARN.
$sel:cachingConfig:Resolver', resolver_cachingConfig - The caching configuration for the resolver.
$sel:responseMappingTemplate:Resolver', resolver_responseMappingTemplate - The response mapping template.
$sel:fieldName:Resolver', resolver_fieldName - The resolver field name.
$sel:syncConfig:Resolver', resolver_syncConfig - The SyncConfig for a resolver attached to a versioned datasource.
$sel:pipelineConfig:Resolver', resolver_pipelineConfig - The PipelineConfig.
resolver_requestMappingTemplate :: Lens' Resolver (Maybe Text) Source #
The request mapping template.
resolver_kind :: Lens' Resolver (Maybe ResolverKind) Source #
The resolver type.
- UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source.
- PIPELINE: A PIPELINE resolver type. A PIPELINE resolver enables
you to execute a series of
Functionin a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.
resolver_cachingConfig :: Lens' Resolver (Maybe CachingConfig) Source #
The caching configuration for the resolver.
resolver_responseMappingTemplate :: Lens' Resolver (Maybe Text) Source #
The response mapping template.
resolver_syncConfig :: Lens' Resolver (Maybe SyncConfig) Source #
The SyncConfig for a resolver attached to a versioned datasource.
resolver_pipelineConfig :: Lens' Resolver (Maybe PipelineConfig) Source #
The PipelineConfig.
SyncConfig
data SyncConfig Source #
Describes a Sync configuration for a resolver.
Contains information on which Conflict Detection as well as Resolution strategy should be performed 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: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 do not match the latest version at the server.
- AUTOMERGE: Resolve conflicts with the Automerge conflict resolution strategy.
- LAMBDA: Resolve conflicts with a Lambda function supplied in the LambdaConflictHandlerConfig.
$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 executing this resolver.
$sel:lambdaConflictHandlerConfig:SyncConfig', syncConfig_lambdaConflictHandlerConfig - The LambdaConflictHandlerConfig when configuring LAMBDA as the
Conflict Handler.
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 do not match the latest version at the server.
- AUTOMERGE: Resolve conflicts with the Automerge conflict resolution strategy.
- LAMBDA: Resolve conflicts with a Lambda function supplied in the LambdaConflictHandlerConfig.
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 executing this resolver.
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 ARN.
$sel:definition:Type', type_definition - The type definition.
$sel:format:Type', type_format - The type format: SDL or JSON.
$sel:name:Type', type_name - The type name.
$sel:description:Type', type_description - The type description.
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.
$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.
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.