aws_appsync_api

account_id

Type: STRING

api_arn

Type: STRING
Provider name: apiArn
Description: The Amazon Resource Name (ARN) for the Api.

api_id

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

created

Type: TIMESTAMP
Provider name: created
Description: The date and time that the Api was created.

dns

Type: MAP_STRING_STRING
Provider name: dns
Description: The DNS records for the API. This will include an HTTP and a real-time endpoint.

event_config

Type: STRUCT
Provider name: eventConfig
Description: The Event API configuration. This includes the default authorization configuration for connecting, publishing, and subscribing to an Event API.

• auth_providers
  Type: UNORDERED_LIST_STRUCT
  Provider name: authProviders
  Description: A list of authorization providers.
  
  • auth_type
    Type: STRING
    Provider name: authType
    Description: The authorization type.
    
  • cognito_config
    Type: STRUCT
    Provider name: cognitoConfig
    Description: Describes an 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.
      
  • lambda_authorizer_config
    Type: STRUCT
    Provider name: lambdaAuthorizerConfig
    
    • 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
    
    • 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.
      
• connection_auth_modes
  Type: UNORDERED_LIST_STRUCT
  Provider name: connectionAuthModes
  Description: A list of valid authorization modes for the Event API connections.
  
  • auth_type
    Type: STRING
    Provider name: authType
    Description: The authorization type.
    
• default_publish_auth_modes
  Type: UNORDERED_LIST_STRUCT
  Provider name: defaultPublishAuthModes
  Description: A list of valid authorization modes for the Event API publishing.
  
  • auth_type
    Type: STRING
    Provider name: authType
    Description: The authorization type.
    
• default_subscribe_auth_modes
  Type: UNORDERED_LIST_STRUCT
  Provider name: defaultSubscribeAuthModes
  Description: A list of valid authorization modes for the Event API subscriptions.
  
  • auth_type
    Type: STRING
    Provider name: authType
    Description: The authorization type.
    
• log_config
  Type: STRUCT
  Provider name: logConfig
  Description: The CloudWatch Logs configuration for the Event API.
  
  • cloud_watch_logs_role_arn
    Type: STRING
    Provider name: cloudWatchLogsRoleArn
    Description: The IAM service role that AppSync assumes to publish CloudWatch Logs in your account.
    
  • log_level
    Type: STRING
    Provider name: logLevel
    Description: The type of information to log for the Event API.
    

name

Type: STRING
Provider name: name
Description: The name of the Api.

owner_contact

Type: STRING
Provider name: ownerContact
Description: The owner contact information for the Api

tags

Type: UNORDERED_LIST_STRING

waf_web_acl_arn

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

xray_enabled

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