The LambdaConflictHandlerConfig object when configuring LAMBDA as the Conflict Handler.
Contents
lambdaConflictHandlerArn
The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2017-07-25 171
LambdaDataSourceConfig
LambdaDataSourceConfig
Describes an AWS Lambda data source configuration.
Contents
lambdaFunctionArn
The Amazon Resource Name (ARN) for the Lambda function.
Type: String Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
LogConfig
The Amazon CloudWatch Logs configuration.
Contents
cloudWatchLogsRoleArn
The service role that AWS AppSync assumes to publish to CloudWatch logs in your account.
Type: String Required: Yes excludeVerboseContent
Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.
Type: Boolean Required: No 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.
Type: String
Valid Values: NONE | ERROR | ALL Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2017-07-25 173
OpenIDConnectConfig
OpenIDConnectConfig
Describes an OpenID Connect (OIDC) configuration.
Contents
authTTL
The number of milliseconds that a token is valid after being authenticated.
Type: Long Required: No 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 AWS AppSync can validate against multiple client identifiers at a time.
Type: String Required: No iatTTL
The number of milliseconds that a token is valid after it's issued to a user.
Type: Long Required: No issuer
The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.
Type: String Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
OpenSearchServiceDataSourceConfig
Describes an OpenSearch data source configuration.
Contents
awsRegion
The AWS Region.
Type: String Required: Yes endpoint
The endpoint.
Type: String Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2017-07-25 175
PipelineConfig
PipelineConfig
The pipeline configuration for a resolver of kind PIPELINE.
Contents
functions
A list of Function objects.
Type: Array of strings Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
RdsHttpEndpointConfig
The Amazon Relational Database Service (Amazon RDS) HTTP endpoint configuration.
Contents
awsRegion
AWS Region for Amazon RDS HTTP endpoint.
Type: String Required: No awsSecretStoreArn
AWS secret store Amazon Resource Name (ARN) for database credentials.
Type: String Required: No databaseName
Logical database name.
Type: String Required: No dbClusterIdentifier
Amazon RDS cluster Amazon Resource Name (ARN).
Type: String Required: No schema
Logical schema name.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2017-07-25 177
RelationalDatabaseDataSourceConfig
RelationalDatabaseDataSourceConfig
Describes a relational database data source configuration.
Contents
rdsHttpEndpointConfig
Amazon RDS HTTP endpoint settings.
Type: RdsHttpEndpointConfig (p. 177) object Required: No
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.
Type: String
Valid Values: RDS_HTTP_ENDPOINT Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Resolver
Describes a resolver.
Contents
cachingConfig
The caching configuration for the resolver.
Type: CachingConfig (p. 155) object Required: No
dataSourceName
The resolver data source name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 65536.
Pattern: [_A-Za-z][_0-9A-Za-z]*
Required: No fieldName
The resolver field name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 65536.
Pattern: [_A-Za-z][_0-9A-Za-z]*
Required: No 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 Function objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.
Type: String
Valid Values: UNIT | PIPELINE Required: No
maxBatchSize
The maximum batching size for a resolver.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 2000.
Required: No
API Version 2017-07-25 179
See Also
pipelineConfig
The PipelineConfig.
Type: PipelineConfig (p. 176) object Required: No
requestMappingTemplate
The request mapping template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 65536.
Pattern: ^.*$
Required: No resolverArn
The resolver Amazon Resource Name (ARN).
Type: String Required: No
responseMappingTemplate
The response mapping template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 65536.
Pattern: ^.*$
Required: No syncConfig
The SyncConfig for a resolver attached to a versioned data source.
Type: SyncConfig (p. 182) object Required: No
typeName
The resolver type name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 65536.
Pattern: [_A-Za-z][_0-9A-Za-z]*
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2017-07-25 181
SyncConfig
SyncConfig
Describes a Sync configuration for a resolver.
Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.
Contents
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.
Type: String
Valid Values: VERSION | NONE Required: No
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 AWS Lambda function supplied in the LambdaConflictHandlerConfig.
Type: String
Valid Values: OPTIMISTIC_CONCURRENCY | LAMBDA | AUTOMERGE | NONE Required: No
lambdaConflictHandlerConfig
The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.
Type: LambdaConflictHandlerConfig (p. 171) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Type
Describes a type.
Contents
arn
The type Amazon Resource Name (ARN).
Type: String Required: No definition
The type definition.
Type: String Required: No description
The type description.
Type: String Required: No format
The type format: SDL or JSON.
Type: String
Valid Values: SDL | JSON Required: No
name
The type name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 65536.
Pattern: [_A-Za-z][_0-9A-Za-z]*
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2017-07-25 183
See Also
UserPoolConfig
Describes an Amazon Cognito user pool configuration.
Contents
appIdClientRegex
A regular expression for validating the incoming Amazon Cognito user pool app client ID.
Type: String Required: No awsRegion
The AWS Region in which the user pool was created.
Type: String Required: Yes 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.
Type: String
Valid Values: ALLOW | DENY Required: Yes
userPoolId
The user pool ID.
Type: String Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2017-07-25 185