String authenticationType
The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.
OpenIDConnectConfig openIDConnectConfig
The OpenID Connect configuration.
CognitoUserPoolConfig userPoolConfig
The Amazon Cognito user pool configuration.
Long ttl
TTL in seconds for cache entries.
Valid values are between 1 and 3600 seconds.
String apiCachingBehavior
Caching behavior.
FULL_REQUEST_CACHING: All requests are fully cached.
PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
Boolean transitEncryptionEnabled
Transit encryption flag when connecting to cache. This setting cannot be updated after creation.
Boolean atRestEncryptionEnabled
At rest encryption flag for cache. This setting cannot be updated after creation.
String 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.
String 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.
String id
The API key ID.
String description
A description of the purpose of the API key.
Long expires
The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour.
Long 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.
String authorizationType
The authorization type required by the HTTP endpoint.
AWS_IAM: The authorization type is Sigv4.
AwsIamConfig awsIamConfig
The AWS IAM settings.
Long ttl
The TTL in seconds for a resolver that has caching enabled.
Valid values are between 1 and 3600 seconds.
List<E> 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.
String apiId
The GraphQL API Id.
Long ttl
TTL in seconds for cache entries.
Valid values are between 1 and 3600 seconds.
Boolean transitEncryptionEnabled
Transit encryption flag when connecting to cache. This setting cannot be updated after creation.
Boolean atRestEncryptionEnabled
At rest encryption flag for cache. This setting cannot be updated after creation.
String apiCachingBehavior
Caching behavior.
FULL_REQUEST_CACHING: All requests are fully cached.
PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
String 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 apiCache
The ApiCache
object.
String apiId
The ID for your GraphQL API.
String description
A description of the purpose of the API key.
Long expires
The time from creation time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour. The default value for this parameter is 7 days from creation time. For more information, see .
ApiKey apiKey
The API key.
String apiId
The API ID for the GraphQL API for the DataSource
.
String name
A user-supplied name for the DataSource
.
String description
A description of the DataSource
.
String type
The type of the DataSource
.
String serviceRoleArn
The AWS IAM service role ARN for the data source. The system assumes this role when accessing the data source.
DynamodbDataSourceConfig dynamodbConfig
Amazon DynamoDB settings.
LambdaDataSourceConfig lambdaConfig
AWS Lambda settings.
ElasticsearchDataSourceConfig elasticsearchConfig
Amazon Elasticsearch Service settings.
HttpDataSourceConfig httpConfig
HTTP endpoint settings.
RelationalDatabaseDataSourceConfig relationalDatabaseConfig
Relational database settings.
DataSource dataSource
The DataSource
object.
String apiId
The GraphQL API ID.
String name
The Function
name. The function name does not have to be unique.
String description
The Function
description.
String dataSourceName
The Function
DataSource
name.
String requestMappingTemplate
The Function
request mapping template. Functions support only the 2018-05-29 version of the request
mapping template.
String responseMappingTemplate
The Function
response mapping template.
String functionVersion
The version
of the request mapping template. Currently the supported value is 2018-05-29.
SyncConfig syncConfig
FunctionConfiguration functionConfiguration
The Function
object.
String name
A user-supplied name for the GraphqlApi
.
LogConfig logConfig
The Amazon CloudWatch Logs configuration.
String authenticationType
The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.
UserPoolConfig userPoolConfig
The Amazon Cognito user pool configuration.
OpenIDConnectConfig openIDConnectConfig
The OpenID Connect configuration.
Map<K,V> tags
A TagMap
object.
List<E> additionalAuthenticationProviders
A list of additional authentication providers for the GraphqlApi
API.
Boolean xrayEnabled
A flag indicating whether to enable X-Ray tracing for the GraphqlApi
.
GraphqlApi graphqlApi
The GraphqlApi
.
String apiId
The ID for the GraphQL API for which the resolver is being created.
String typeName
The name of the Type
.
String fieldName
The name of the field to attach the resolver to.
String dataSourceName
The name of the data source for which the resolver is being created.
String requestMappingTemplate
The mapping template to be used for requests.
A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source can understand. Mapping templates are written in Apache Velocity Template Language (VTL).
VTL request mapping templates are optional when using a Lambda data source. For all other data sources, VTL request and response mapping templates are required.
String responseMappingTemplate
The mapping template to be used for responses from the data source.
String 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
Function
in a serial manner. You can use a pipeline resolver to execute a GraphQL query against
multiple data sources.
PipelineConfig pipelineConfig
The PipelineConfig
.
SyncConfig syncConfig
The SyncConfig
for a resolver attached to a versioned datasource.
CachingConfig cachingConfig
The caching configuration for the resolver.
Resolver resolver
The Resolver
object.
String apiId
The API ID.
String definition
The type definition, in GraphQL Schema Definition Language (SDL) format.
For more information, see the GraphQL SDL documentation.
String format
The type format: SDL or JSON.
Type type
The Type
object.
String dataSourceArn
The data source ARN.
String name
The name of the data source.
String description
The description of the data source.
String type
The type of the data source.
AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table.
AMAZON_ELASTICSEARCH: The data source is an Amazon Elasticsearch Service domain.
AWS_LAMBDA: The data source is an AWS Lambda function.
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.
String serviceRoleArn
The AWS IAM service role ARN for the data source. The system assumes this role when accessing the data source.
DynamodbDataSourceConfig dynamodbConfig
Amazon DynamoDB settings.
LambdaDataSourceConfig lambdaConfig
AWS Lambda settings.
ElasticsearchDataSourceConfig elasticsearchConfig
Amazon Elasticsearch Service settings.
HttpDataSourceConfig httpConfig
HTTP endpoint settings.
RelationalDatabaseDataSourceConfig relationalDatabaseConfig
Relational database settings.
String apiId
The API ID.
String apiId
The API ID.
String tableName
The table name.
String awsRegion
The AWS Region.
Boolean useCallerCredentials
Set to TRUE to use Amazon Cognito credentials with this data source.
DeltaSyncConfig deltaSyncConfig
The DeltaSyncConfig
for a versioned datasource.
Boolean versioned
Set to TRUE to use Conflict Detection and Resolution with this data source.
String apiId
The API ID.
String functionId
A unique ID representing the Function
object.
String functionArn
The ARN of the Function
object.
String name
The name of the Function
object.
String description
The Function
description.
String dataSourceName
The name of the DataSource
.
String requestMappingTemplate
The Function
request mapping template. Functions support only the 2018-05-29 version of the request
mapping template.
String responseMappingTemplate
The Function
response mapping template.
String functionVersion
The version of the request mapping template. Currently only the 2018-05-29 version of the template is supported.
SyncConfig syncConfig
String apiId
The API ID.
ApiCache apiCache
The ApiCache
object.
DataSource dataSource
The DataSource
object.
FunctionConfiguration functionConfiguration
The Function
object.
String apiId
The API ID for the GraphQL API.
GraphqlApi graphqlApi
The GraphqlApi
object.
ByteBuffer schema
The schema, in GraphQL Schema Definition Language (SDL) format.
For more information, see the GraphQL SDL documentation.
Resolver resolver
The Resolver
object.
String apiId
The API ID.
Type type
The Type
object.
String name
The API name.
String apiId
The API ID.
String authenticationType
The authentication type.
LogConfig logConfig
The Amazon CloudWatch Logs configuration.
UserPoolConfig userPoolConfig
The Amazon Cognito user pool configuration.
OpenIDConnectConfig openIDConnectConfig
The OpenID Connect configuration.
String arn
The ARN.
Map<K,V> uris
The URIs.
Map<K,V> tags
The tags.
List<E> additionalAuthenticationProviders
A list of additional authentication providers for the GraphqlApi
API.
Boolean xrayEnabled
A flag representing whether X-Ray tracing is enabled for this GraphqlApi
.
String wafWebAclArn
The ARN of the AWS Web Application Firewall (WAF) ACL associated with this GraphqlApi
, if one
exists.
String 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, AWS AppSync uses the default port 80 for the HTTP endpoint and port 443 for HTTPS endpoints.
AuthorizationConfig authorizationConfig
The authorization config in case the HTTP endpoint requires authorization.
String lambdaConflictHandlerArn
The Arn for the Lambda function to use as the Conflict Handler.
String lambdaFunctionArn
The ARN for the Lambda function.
String apiId
The API ID.
String functionId
The Function ID.
String nextToken
An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.
Integer maxResults
The maximum number of results you want the request to return.
String apiId
The API ID.
String typeName
The type name.
String nextToken
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
Integer maxResults
The maximum number of results you want the request to return.
String resourceArn
The GraphqlApi
ARN.
String apiId
The API ID.
String format
The type format: SDL or JSON.
String nextToken
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
Integer maxResults
The maximum number of results you want the request to return.
String 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.
String cloudWatchLogsRoleArn
The service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in your account.
Boolean excludeVerboseContent
Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.
String issuer
The issuer for the OpenID Connect configuration. The issuer returned by discovery must exactly match the value of
iss
in the ID token.
String 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 AWS AppSync can validate against multiple client identifiers at a time.
Long iatTTL
The number of milliseconds a token is valid after being issued to a user.
Long authTTL
The number of milliseconds a token is valid after being authenticated.
String awsRegion
AWS Region for RDS HTTP endpoint.
String dbClusterIdentifier
Amazon RDS cluster ARN.
String databaseName
Logical database name.
String schema
Logical schema name.
String awsSecretStoreArn
AWS secret store ARN for database credentials.
String relationalDatabaseSourceType
Source type for the relational database.
RDS_HTTP_ENDPOINT: The relational database source type is an Amazon RDS HTTP endpoint.
RdsHttpEndpointConfig rdsHttpEndpointConfig
Amazon RDS HTTP endpoint settings.
String typeName
The resolver type name.
String fieldName
The resolver field name.
String dataSourceName
The resolver data source name.
String resolverArn
The resolver ARN.
String requestMappingTemplate
The request mapping template.
String responseMappingTemplate
The response mapping template.
String 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
Function
in a serial manner. You can use a pipeline resolver to execute a GraphQL query against
multiple data sources.
PipelineConfig pipelineConfig
The PipelineConfig
.
SyncConfig syncConfig
The SyncConfig
for a resolver attached to a versioned datasource.
CachingConfig cachingConfig
The caching configuration for the resolver.
String apiId
The API ID.
ByteBuffer definition
The schema definition, in GraphQL schema language format.
String status
The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data.
String 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.
String 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.
LambdaConflictHandlerConfig lambdaConflictHandlerConfig
The LambdaConflictHandlerConfig
when configuring LAMBDA as the Conflict Handler.
String apiId
The GraphQL API Id.
Long ttl
TTL in seconds for cache entries.
Valid values are between 1 and 3600 seconds.
String apiCachingBehavior
Caching behavior.
FULL_REQUEST_CACHING: All requests are fully cached.
PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
String 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 apiCache
The ApiCache
object.
String apiId
The ID for the GraphQL API.
String id
The API key ID.
String description
A description of the purpose of the API key.
Long expires
The time from update time after which the API key expires. The date is represented as seconds since the epoch. For more information, see .
ApiKey apiKey
The API key.
String apiId
The API ID.
String name
The new name for the data source.
String description
The new description for the data source.
String type
The new data source type.
String serviceRoleArn
The new service role ARN for the data source.
DynamodbDataSourceConfig dynamodbConfig
The new Amazon DynamoDB configuration.
LambdaDataSourceConfig lambdaConfig
The new AWS Lambda configuration.
ElasticsearchDataSourceConfig elasticsearchConfig
The new Elasticsearch Service configuration.
HttpDataSourceConfig httpConfig
The new HTTP endpoint configuration.
RelationalDatabaseDataSourceConfig relationalDatabaseConfig
The new relational database configuration.
DataSource dataSource
The updated DataSource
object.
String apiId
The GraphQL API ID.
String name
The Function
name.
String description
The Function
description.
String functionId
The function ID.
String dataSourceName
The Function
DataSource
name.
String requestMappingTemplate
The Function
request mapping template. Functions support only the 2018-05-29 version of the request
mapping template.
String responseMappingTemplate
The Function
request mapping template.
String functionVersion
The version
of the request mapping template. Currently the supported value is 2018-05-29.
SyncConfig syncConfig
FunctionConfiguration functionConfiguration
The Function
object.
String apiId
The API ID.
String name
The new name for the GraphqlApi
object.
LogConfig logConfig
The Amazon CloudWatch Logs configuration for the GraphqlApi
object.
String authenticationType
The new authentication type for the GraphqlApi
object.
UserPoolConfig userPoolConfig
The new Amazon Cognito user pool configuration for the GraphqlApi
object.
OpenIDConnectConfig openIDConnectConfig
The OpenID Connect configuration for the GraphqlApi
object.
List<E> additionalAuthenticationProviders
A list of additional authentication providers for the GraphqlApi
API.
Boolean xrayEnabled
A flag indicating whether to enable X-Ray tracing for the GraphqlApi
.
GraphqlApi graphqlApi
The updated GraphqlApi
object.
String apiId
The API ID.
String typeName
The new type name.
String fieldName
The new field name.
String dataSourceName
The new data source name.
String requestMappingTemplate
The new request mapping template.
A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source can understand. Mapping templates are written in Apache Velocity Template Language (VTL).
VTL request mapping templates are optional when using a Lambda data source. For all other data sources, VTL request and response mapping templates are required.
String responseMappingTemplate
The new response mapping template.
String 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
Function
in a serial manner. You can use a pipeline resolver to execute a GraphQL query against
multiple data sources.
PipelineConfig pipelineConfig
The PipelineConfig
.
SyncConfig syncConfig
The SyncConfig
for a resolver attached to a versioned datasource.
CachingConfig cachingConfig
The caching configuration for the resolver.
Resolver resolver
The updated Resolver
object.
Type type
The updated Type
object.
String userPoolId
The user pool ID.
String awsRegion
The AWS Region in which the user pool was created.
String 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.
String appIdClientRegex
A regular expression for validating the incoming Amazon Cognito user pool app client ID.
Copyright © 2021. All rights reserved.