This page is not yet available in Spanish. We are working on its translation.
If you have any questions or feedback about our current translation project, feel free to reach out to us!

aws_appsync_graphql_api

account_id

Type: STRING

additional_authentication_providers

Type: UNORDERED_LIST_STRUCT
Provider name: additionalAuthenticationProviders
Description: A list of additional authentication providers for the GraphqlApi API.

  • authentication_type
    Type: STRING
    Provider name: authenticationType
    Description: The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
  • lambda_authorizer_config
    Type: STRUCT
    Provider name: lambdaAuthorizerConfig
    Description: Configuration for Lambda function authorization.
    • authorizer_result_ttl_in_seconds
      Type: INT32
      Provider name: authorizerResultTtlInSeconds
      Description: The number of seconds a response should be cached for. The default is 0 seconds, which disables caching. If you don’t specify a value for authorizerResultTtlInSeconds, the default value is used. The maximum value is one hour (3600 seconds). The Lambda function can override this by returning a ttlOverride key in its response.
    • authorizer_uri
      Type: STRING
      Provider name: authorizerUri
      Description: The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can be a standard Lambda ARN, a version ARN (…/v3), or an alias ARN. Note: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is done for you. To use the Command Line Interface (CLI), run the following: aws lambda add-permission –function-name “arn:aws:lambda:us-east-2:111122223333:function:my-function” –statement-id “appsync” –principal appsync.amazonaws.com –action lambda:InvokeFunction
    • identity_validation_expression
      Type: STRING
      Provider name: identityValidationExpression
      Description: A regular expression for validation of tokens before the Lambda function is called.
  • open_id_connect_config
    Type: STRUCT
    Provider name: openIDConnectConfig
    Description: The OIDC configuration.
    • auth_ttl
      Type: INT64
      Provider name: authTTL
      Description: The number of milliseconds that a token is valid after being authenticated.
    • client_id
      Type: STRING
      Provider name: clientId
      Description: The client identifier of the relying party at the OpenID identity provider. This identifier is typically obtained when the relying party is registered with the OpenID identity provider. You can specify a regular expression so that AppSync can validate against multiple client identifiers at a time.
    • iat_ttl
      Type: INT64
      Provider name: iatTTL
      Description: The number of milliseconds that a token is valid after it’s issued to a user.
    • issuer
      Type: STRING
      Provider name: issuer
      Description: The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.
  • user_pool_config
    Type: STRUCT
    Provider name: userPoolConfig
    Description: The Amazon Cognito user pool configuration.
    • app_id_client_regex
      Type: STRING
      Provider name: appIdClientRegex
      Description: A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn’t set, no filtering is applied.
    • aws_region
      Type: STRING
      Provider name: awsRegion
      Description: The Amazon Web Services Region in which the user pool was created.
    • user_pool_id
      Type: STRING
      Provider name: userPoolId
      Description: The user pool ID.

api_id

Type: STRING
Provider name: apiId
Description: The API ID.

api_type

Type: STRING
Provider name: apiType
Description: The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED).

arn

Type: STRING
Provider name: arn
Description: The Amazon Resource Name (ARN).

authentication_type

Type: STRING
Provider name: authenticationType
Description: The authentication type.

dns

Type: MAP_STRING_STRING
Provider name: dns
Description: The DNS records for the API.

enhanced_metrics_config

Type: STRUCT
Provider name: enhancedMetricsConfig
Description: The enhancedMetricsConfig object.

  • data_source_level_metrics_behavior
    Type: STRING
    Provider name: dataSourceLevelMetricsBehavior
    Description: Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:
    • Requests: The number of invocations that occured during a request.
    • Latency: The time to complete a data source invocation.
    • Errors: The number of errors that occurred during a data source invocation.
    These metrics can be emitted to CloudWatch per data source or for all data sources in the request. Metrics will be recorded by API ID and data source name. dataSourceLevelMetricsBehavior accepts one of these values at a time:
    • FULL_REQUEST_DATA_SOURCE_METRICS: Records and emits metric data for all data sources in the request.
    • PER_DATA_SOURCE_METRICS: Records and emits metric data for data sources that have the metricsConfig value set to ENABLED.
  • operation_level_metrics_config
    Type: STRING
    Provider name: operationLevelMetricsConfig
    Description: Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:
    • Requests: The number of times a specified GraphQL operation was called.
    • GraphQL errors: The number of GraphQL errors that occurred during a specified GraphQL operation.
    Metrics will be recorded by API ID and operation name. You can set the value to ENABLED or DISABLED.
  • resolver_level_metrics_behavior
    Type: STRING
    Provider name: resolverLevelMetricsBehavior
    Description: Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:
    • GraphQL errors: The number of GraphQL errors that occurred.
    • Requests: The number of invocations that occurred during a request.
    • Latency: The time to complete a resolver invocation.
    • Cache hits: The number of cache hits during a request.
    • Cache misses: The number of cache misses during a request.
    These metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics will be recorded by API ID and resolver name. resolverLevelMetricsBehavior accepts one of these values at a time:
    • FULL_REQUEST_RESOLVER_METRICS: Records and emits metric data for all resolvers in the request.
    • PER_RESOLVER_METRICS: Records and emits metric data for resolvers that have the metricsConfig value set to ENABLED.

introspection_config

Type: STRING
Provider name: introspectionConfig
Description: Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED) introspection. If no value is provided, the introspection configuration will be set to ENABLED by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled. For more information about introspection, see GraphQL introspection.

lambda_authorizer_config

Type: STRUCT
Provider name: lambdaAuthorizerConfig
Description: Configuration for Lambda function authorization.

  • authorizer_result_ttl_in_seconds
    Type: INT32
    Provider name: authorizerResultTtlInSeconds
    Description: The number of seconds a response should be cached for. The default is 0 seconds, which disables caching. If you don’t specify a value for authorizerResultTtlInSeconds, the default value is used. The maximum value is one hour (3600 seconds). The Lambda function can override this by returning a ttlOverride key in its response.
  • authorizer_uri
    Type: STRING
    Provider name: authorizerUri
    Description: The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can be a standard Lambda ARN, a version ARN (…/v3), or an alias ARN. Note: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is done for you. To use the Command Line Interface (CLI), run the following: aws lambda add-permission –function-name “arn:aws:lambda:us-east-2:111122223333:function:my-function” –statement-id “appsync” –principal appsync.amazonaws.com –action lambda:InvokeFunction
  • identity_validation_expression
    Type: STRING
    Provider name: identityValidationExpression
    Description: A regular expression for validation of tokens before the Lambda function is called.

log_config

Type: STRUCT
Provider name: logConfig
Description: The Amazon CloudWatch Logs configuration.

  • cloud_watch_logs_role_arn
    Type: STRING
    Provider name: cloudWatchLogsRoleArn
    Description: The service role that AppSync assumes to publish to CloudWatch logs in your account.
  • exclude_verbose_content
    Type: BOOLEAN
    Provider name: excludeVerboseContent
    Description: Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.
  • field_log_level
    Type: STRING
    Provider name: fieldLogLevel
    Description: 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.

merged_api_execution_role_arn

Type: STRING
Provider name: mergedApiExecutionRoleArn
Description: The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the AUTO_MERGE to update the merged API endpoint with the source API changes automatically.

name

Type: STRING
Provider name: name
Description: The API name.

open_id_connect_config

Type: STRUCT
Provider name: openIDConnectConfig
Description: The OpenID Connect configuration.

  • auth_ttl
    Type: INT64
    Provider name: authTTL
    Description: The number of milliseconds that a token is valid after being authenticated.
  • client_id
    Type: STRING
    Provider name: clientId
    Description: The client identifier of the relying party at the OpenID identity provider. This identifier is typically obtained when the relying party is registered with the OpenID identity provider. You can specify a regular expression so that AppSync can validate against multiple client identifiers at a time.
  • iat_ttl
    Type: INT64
    Provider name: iatTTL
    Description: The number of milliseconds that a token is valid after it’s issued to a user.
  • issuer
    Type: STRING
    Provider name: issuer
    Description: The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.

owner

Type: STRING
Provider name: owner
Description: The account owner of the GraphQL API.

owner_contact

Type: STRING
Provider name: ownerContact
Description: The owner contact information for an API resource. This field accepts any string input with a length of 0 - 256 characters.

query_depth_limit

Type: INT32
Provider name: queryDepthLimit
Description: The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. The default value is 0 (or unspecified), which indicates there’s no depth limit. If you set a limit, it can be between 1 and 75 nested levels. This field will produce a limit error if the operation falls out of bounds. Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.

resolver_count_limit

Type: INT32
Provider name: resolverCountLimit
Description: The maximum number of resolvers that can be invoked in a single request. The default value is 0 (or unspecified), which will set the limit to 10000. When specified, the limit value can be between 1 and 10000. This field will produce a limit error if the operation falls out of bounds.

tags

Type: UNORDERED_LIST_STRING

uris

Type: MAP_STRING_STRING
Provider name: uris
Description: The URIs.

user_pool_config

Type: STRUCT
Provider name: userPoolConfig
Description: The Amazon Cognito user pool configuration.

  • app_id_client_regex
    Type: STRING
    Provider name: appIdClientRegex
    Description: A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn’t set, no filtering is applied.
  • aws_region
    Type: STRING
    Provider name: awsRegion
    Description: The Amazon Web Services Region in which the user pool was created.
  • default_action
    Type: STRING
    Provider name: defaultAction
    Description: 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.
  • user_pool_id
    Type: STRING
    Provider name: userPoolId
    Description: The user pool ID.

visibility

Type: STRING
Provider name: visibility
Description: Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed once the API has been created.

waf_web_acl_arn

Type: STRING
Provider name: wafWebAclArn
Description: The ARN of the WAF access control list (ACL) associated with this GraphqlApi, if one exists.

xray_enabled

Type: BOOLEAN
Provider name: xrayEnabled
Description: A flag indicating whether to use X-Ray tracing for this GraphqlApi.