This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html). # AWS::AppSync::GraphQLApi The `AWS::AppSync::GraphQLApi` resource creates a new AWS AppSync GraphQL API. This is the top-level construct for your application. For more information, see [Quick Start](https://docs.aws.amazon.com/appsync/latest/devguide/quickstart.html) in the *AWS AppSync Developer Guide*. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::AppSync::GraphQLApi", "Properties" : { "[AdditionalAuthenticationProviders](#cfn-appsync-graphqlapi-additionalauthenticationproviders)" : [ AdditionalAuthenticationProvider, ... ], "[ApiType](#cfn-appsync-graphqlapi-apitype)" : String, "[AuthenticationType](#cfn-appsync-graphqlapi-authenticationtype)" : String, "[EnhancedMetricsConfig](#cfn-appsync-graphqlapi-enhancedmetricsconfig)" : EnhancedMetricsConfig, "[EnvironmentVariables](#cfn-appsync-graphqlapi-environmentvariables)" : {Key: Value, ...}, "[IntrospectionConfig](#cfn-appsync-graphqlapi-introspectionconfig)" : String, "[LambdaAuthorizerConfig](#cfn-appsync-graphqlapi-lambdaauthorizerconfig)" : LambdaAuthorizerConfig, "[LogConfig](#cfn-appsync-graphqlapi-logconfig)" : LogConfig, "[MergedApiExecutionRoleArn](#cfn-appsync-graphqlapi-mergedapiexecutionrolearn)" : String, "[Name](#cfn-appsync-graphqlapi-name)" : String, "[OpenIDConnectConfig](#cfn-appsync-graphqlapi-openidconnectconfig)" : OpenIDConnectConfig, "[OwnerContact](#cfn-appsync-graphqlapi-ownercontact)" : String, "[QueryDepthLimit](#cfn-appsync-graphqlapi-querydepthlimit)" : Integer, "[ResolverCountLimit](#cfn-appsync-graphqlapi-resolvercountlimit)" : Integer, "[Tags](#cfn-appsync-graphqlapi-tags)" : [ Tag, ... ], "[UserPoolConfig](#cfn-appsync-graphqlapi-userpoolconfig)" : UserPoolConfig, "[Visibility](#cfn-appsync-graphqlapi-visibility)" : String, "[XrayEnabled](#cfn-appsync-graphqlapi-xrayenabled)" : Boolean } } ``` ### YAML ``` Type: AWS::AppSync::GraphQLApi Properties: [AdditionalAuthenticationProviders](#cfn-appsync-graphqlapi-additionalauthenticationproviders): - AdditionalAuthenticationProvider [ApiType](#cfn-appsync-graphqlapi-apitype): String [AuthenticationType](#cfn-appsync-graphqlapi-authenticationtype): String [EnhancedMetricsConfig](#cfn-appsync-graphqlapi-enhancedmetricsconfig): EnhancedMetricsConfig [EnvironmentVariables](#cfn-appsync-graphqlapi-environmentvariables): Key: Value [IntrospectionConfig](#cfn-appsync-graphqlapi-introspectionconfig): String [LambdaAuthorizerConfig](#cfn-appsync-graphqlapi-lambdaauthorizerconfig): LambdaAuthorizerConfig [LogConfig](#cfn-appsync-graphqlapi-logconfig): LogConfig [MergedApiExecutionRoleArn](#cfn-appsync-graphqlapi-mergedapiexecutionrolearn): String [Name](#cfn-appsync-graphqlapi-name): String [OpenIDConnectConfig](#cfn-appsync-graphqlapi-openidconnectconfig): OpenIDConnectConfig [OwnerContact](#cfn-appsync-graphqlapi-ownercontact): String [QueryDepthLimit](#cfn-appsync-graphqlapi-querydepthlimit): Integer [ResolverCountLimit](#cfn-appsync-graphqlapi-resolvercountlimit): Integer [Tags](#cfn-appsync-graphqlapi-tags): - Tag [UserPoolConfig](#cfn-appsync-graphqlapi-userpoolconfig): UserPoolConfig [Visibility](#cfn-appsync-graphqlapi-visibility): String [XrayEnabled](#cfn-appsync-graphqlapi-xrayenabled): Boolean ``` ## Properties `AdditionalAuthenticationProviders` A list of additional authentication providers for the `GraphqlApi` API. *Required*: No *Type*: Array of [AdditionalAuthenticationProvider](aws-properties-appsync-graphqlapi-additionalauthenticationprovider.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ApiType` The value that indicates whether the GraphQL API is a standard API (`GRAPHQL`) or merged API (`MERGED`). **WARNING**: If the `ApiType` has not been defined, **explicitly** setting it to `GRAPHQL` in a template/stack update will result in an API replacement and new DNS values. The following values are valid: `GRAPHQL | MERGED` *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AuthenticationType` Security configuration for your GraphQL API. For allowed values (such as `API_KEY`, `AWS_IAM`, `AMAZON_COGNITO_USER_POOLS`, `OPENID_CONNECT`, or `AWS_LAMBDA`), see [Security](https://docs.aws.amazon.com/appsync/latest/devguide/security.html) in the *AWS AppSync Developer Guide*. *Required*: Yes *Type*: String *Allowed values*: `API_KEY | AWS_IAM | AMAZON_COGNITO_USER_POOLS | OPENID_CONNECT | AWS_LAMBDA` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EnhancedMetricsConfig` Enables and controls the enhanced metrics feature. Enhanced metrics emit granular data on API usage and performance such as AppSync request and error counts, latency, and cache hits/misses. All enhanced metric data is sent to your CloudWatch account, and you can configure the types of data that will be sent. Enhanced metrics can be configured at the resolver, data source, and operation levels. For more information, see [Monitoring and logging](https://docs.aws.amazon.com//appsync/latest/devguide/monitoring.html#cw-metrics) in the *AWS AppSync User Guide*. *Required*: No *Type*: [EnhancedMetricsConfig](aws-properties-appsync-graphqlapi-enhancedmetricsconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EnvironmentVariables` A map containing the list of resources with their properties and environment variables. For more information, see [Environmental variables](https://docs.aws.amazon.com/appsync/latest/devguide/environmental-variables.html). *Pattern*: `^[A-Za-z]+\\w*$\\` *Minimum*: 2 *Maximum*: 64 *Required*: No *Type*: Object of String *Pattern*: `^[A-Za-z]+\w*$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IntrospectionConfig` 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](https://graphql.org/learn/introspection/). *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LambdaAuthorizerConfig` A `LambdaAuthorizerConfig` holds configuration on how to authorize AWS AppSync API access when using the `AWS_LAMBDA` authorizer mode. Be aware that an AWS AppSync API may have only one Lambda authorizer configured at a time. *Required*: No *Type*: [LambdaAuthorizerConfig](aws-properties-appsync-graphqlapi-lambdaauthorizerconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LogConfig` The Amazon CloudWatch Logs configuration. *Required*: No *Type*: [LogConfig](aws-properties-appsync-graphqlapi-logconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MergedApiExecutionRoleArn` The AWS 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. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The API name. *Required*: Yes *Type*: String *Pattern*: `[_A-Za-z][_0-9A-Za-z]*` *Minimum*: `1` *Maximum*: `65536` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OpenIDConnectConfig` The OpenID Connect configuration. *Required*: No *Type*: [OpenIDConnectConfig](aws-properties-appsync-graphqlapi-openidconnectconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OwnerContact` The owner contact information for an API resource. This field accepts any string input with a length of 0 - 256 characters. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `QueryDepthLimit` 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. *Required*: No *Type*: Integer *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ResolverCountLimit` 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. *Required*: No *Type*: Integer *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` An arbitrary set of tags (key-value pairs) for this GraphQL API. *Required*: No *Type*: Array of [Tag](aws-properties-appsync-graphqlapi-tag.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `UserPoolConfig` Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint. *Required*: No *Type*: [UserPoolConfig](aws-properties-appsync-graphqlapi-userpoolconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Visibility` Sets the scope of the GraphQL API to public (`GLOBAL`) or private (`PRIVATE`). By default, the scope is set to `Global` if no value is provided. **WARNING**: If `Visibility` has not been defined, **explicitly** setting it to `GLOBAL` in a template/stack update will result in an API replacement and new DNS values. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `XrayEnabled` A flag indicating whether to use AWS X-Ray tracing for this `GraphqlApi`. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of an `AWS::AppSync::GraphQLApi` resource to the intrinsic `Ref` function, the function returns the ARN of the GraphQL API, such as `arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid`. For more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref). ### Fn::GetAtt `Fn::GetAtt` returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using `Fn::GetAtt`, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt). #### `ApiId` Unique AWS AppSync GraphQL API identifier. `Arn` The Amazon Resource Name (ARN) of the API key, such as `arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid`. `GraphQLDns` The fully qualified domain name (FQDN) of the endpoint URL of your GraphQL API. `GraphQLEndpointArn` The GraphQL endpoint ARN. `GraphQLUrl` The Endpoint URL of your GraphQL API. `RealtimeDns` The fully qualified domain name (FQDN) of the real-time endpoint URL of your GraphQL API. `RealtimeUrl` The GraphQL API real-time endpoint URL. For more information, see [Discovering the real-time endpoint from the GraphQL endpoint](https://docs.aws.amazon.com/appsync/latest/devguide/real-time-websocket-client.html#handshake-details-to-establish-the-websocket-connection). ## Examples ### GraphQL API Creation Example The following example creates a GraphQL API. #### YAML ``` Parameters: graphQlApiName: Type: String userPoolId: Type: String userPoolAwsRegion: Type: String defaultAction: Type: String Resources: GraphQLApi: Type: AWS::AppSync::GraphQLApi Properties: Name: Ref: graphQlApiName AuthenticationType: "AMAZON_COGNITO_USER_POOLS" UserPoolConfig: UserPoolId: Ref: userPoolId AwsRegion: Ref: userPoolAwsRegion DefaultAction: Ref: defaultAction ``` #### JSON ``` { "Parameters": { "graphQlApiName": { "Type": "String" }, "userPoolId": { "Type": "String" }, "userPoolAwsRegion": { "Type": "String" }, "defaultAction": { "Type": "String" } }, "Resources": { "GraphQLApi": { "Type": "AWS::AppSync::GraphQLApi", "Properties": { "Name": { "Ref": "graphQlApiName" }, "AuthenticationType": "AMAZON_COGNITO_USER_POOLS", "UserPoolConfig": { "UserPoolId": { "Ref": "userPoolId" }, "AwsRegion": { "Ref": "userPoolAwsRegion" }, "DefaultAction": { "Ref": "defaultAction" } } } } } } ``` ## See also + [CreateGraphqlApi](https://docs.aws.amazon.com/appsync/latest/APIReference/API_CreateGraphqlApi.html) operation in the *AWS AppSync API Reference*. # AWS::AppSync::GraphQLApi AdditionalAuthenticationProvider Describes an additional authentication provider. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AuthenticationType](#cfn-appsync-graphqlapi-additionalauthenticationprovider-authenticationtype)" : String, "[LambdaAuthorizerConfig](#cfn-appsync-graphqlapi-additionalauthenticationprovider-lambdaauthorizerconfig)" : LambdaAuthorizerConfig, "[OpenIDConnectConfig](#cfn-appsync-graphqlapi-additionalauthenticationprovider-openidconnectconfig)" : OpenIDConnectConfig, "[UserPoolConfig](#cfn-appsync-graphqlapi-additionalauthenticationprovider-userpoolconfig)" : CognitoUserPoolConfig } ``` ### YAML ``` [AuthenticationType](#cfn-appsync-graphqlapi-additionalauthenticationprovider-authenticationtype): String [LambdaAuthorizerConfig](#cfn-appsync-graphqlapi-additionalauthenticationprovider-lambdaauthorizerconfig): LambdaAuthorizerConfig [OpenIDConnectConfig](#cfn-appsync-graphqlapi-additionalauthenticationprovider-openidconnectconfig): OpenIDConnectConfig [UserPoolConfig](#cfn-appsync-graphqlapi-additionalauthenticationprovider-userpoolconfig): CognitoUserPoolConfig ``` ## Properties `AuthenticationType` The authentication type for API key, AWS Identity and Access Management, OIDC, Amazon Cognito user pools, or AWS Lambda. Valid Values: `API_KEY` \$1 `AWS_IAM` \$1 `OPENID_CONNECT` \$1 `AMAZON_COGNITO_USER_POOLS` \$1 `AWS_LAMBDA` *Required*: Yes *Type*: String *Allowed values*: `API_KEY | AWS_IAM | AMAZON_COGNITO_USER_POOLS | OPENID_CONNECT | AWS_LAMBDA` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LambdaAuthorizerConfig` Configuration for AWS Lambda function authorization. *Required*: No *Type*: [LambdaAuthorizerConfig](aws-properties-appsync-graphqlapi-lambdaauthorizerconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OpenIDConnectConfig` The OIDC configuration. *Required*: No *Type*: [OpenIDConnectConfig](aws-properties-appsync-graphqlapi-openidconnectconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `UserPoolConfig` The Amazon Cognito user pool configuration. *Required*: No *Type*: [CognitoUserPoolConfig](aws-properties-appsync-graphqlapi-cognitouserpoolconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppSync::GraphQLApi CognitoUserPoolConfig Describes an Amazon Cognito user pool configuration. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AppIdClientRegex](#cfn-appsync-graphqlapi-cognitouserpoolconfig-appidclientregex)" : String, "[AwsRegion](#cfn-appsync-graphqlapi-cognitouserpoolconfig-awsregion)" : String, "[UserPoolId](#cfn-appsync-graphqlapi-cognitouserpoolconfig-userpoolid)" : String } ``` ### YAML ``` [AppIdClientRegex](#cfn-appsync-graphqlapi-cognitouserpoolconfig-appidclientregex): String [AwsRegion](#cfn-appsync-graphqlapi-cognitouserpoolconfig-awsregion): String [UserPoolId](#cfn-appsync-graphqlapi-cognitouserpoolconfig-userpoolid): String ``` ## Properties `AppIdClientRegex` A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AwsRegion` The AWS Region in which the user pool was created. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `UserPoolId` The user pool ID. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppSync::GraphQLApi EnhancedMetricsConfig Describes an enhanced metrics configuration. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DataSourceLevelMetricsBehavior](#cfn-appsync-graphqlapi-enhancedmetricsconfig-datasourcelevelmetricsbehavior)" : String, "[OperationLevelMetricsConfig](#cfn-appsync-graphqlapi-enhancedmetricsconfig-operationlevelmetricsconfig)" : String, "[ResolverLevelMetricsBehavior](#cfn-appsync-graphqlapi-enhancedmetricsconfig-resolverlevelmetricsbehavior)" : String } ``` ### YAML ``` [DataSourceLevelMetricsBehavior](#cfn-appsync-graphqlapi-enhancedmetricsconfig-datasourcelevelmetricsbehavior): String [OperationLevelMetricsConfig](#cfn-appsync-graphqlapi-enhancedmetricsconfig-operationlevelmetricsconfig): String [ResolverLevelMetricsBehavior](#cfn-appsync-graphqlapi-enhancedmetricsconfig-resolverlevelmetricsbehavior): String ``` ## Properties `DataSourceLevelMetricsBehavior` 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`. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OperationLevelMetricsConfig` 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`. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ResolverLevelMetricsBehavior` 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`. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppSync::GraphQLApi LambdaAuthorizerConfig Configuration for AWS Lambda function authorization. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AuthorizerResultTtlInSeconds](#cfn-appsync-graphqlapi-lambdaauthorizerconfig-authorizerresultttlinseconds)" : Integer, "[AuthorizerUri](#cfn-appsync-graphqlapi-lambdaauthorizerconfig-authorizeruri)" : String, "[IdentityValidationExpression](#cfn-appsync-graphqlapi-lambdaauthorizerconfig-identityvalidationexpression)" : String } ``` ### YAML ``` [AuthorizerResultTtlInSeconds](#cfn-appsync-graphqlapi-lambdaauthorizerconfig-authorizerresultttlinseconds): Integer [AuthorizerUri](#cfn-appsync-graphqlapi-lambdaauthorizerconfig-authorizeruri): String [IdentityValidationExpression](#cfn-appsync-graphqlapi-lambdaauthorizerconfig-identityvalidationexpression): String ``` ## Properties `AuthorizerResultTtlInSeconds` 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. *Required*: No *Type*: Integer *Minimum*: `0` *Maximum*: `3600` *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `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 AWS 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` *Required*: No *Type*: String *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `IdentityValidationExpression` A regular expression for validation of tokens before the Lambda function is called. *Required*: No *Type*: String *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) # AWS::AppSync::GraphQLApi LogConfig The `LogConfig` property type specifies the logging configuration when writing GraphQL operations and tracing to Amazon CloudWatch for an AWS AppSync GraphQL API. `LogConfig` is a property of the [AWS::AppSync::GraphQLApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html) property type. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CloudWatchLogsRoleArn](#cfn-appsync-graphqlapi-logconfig-cloudwatchlogsrolearn)" : String, "[ExcludeVerboseContent](#cfn-appsync-graphqlapi-logconfig-excludeverbosecontent)" : Boolean, "[FieldLogLevel](#cfn-appsync-graphqlapi-logconfig-fieldloglevel)" : String } ``` ### YAML ``` [CloudWatchLogsRoleArn](#cfn-appsync-graphqlapi-logconfig-cloudwatchlogsrolearn): String [ExcludeVerboseContent](#cfn-appsync-graphqlapi-logconfig-excludeverbosecontent): Boolean [FieldLogLevel](#cfn-appsync-graphqlapi-logconfig-fieldloglevel): String ``` ## Properties `CloudWatchLogsRoleArn` The service role that AWS AppSync will assume to publish to Amazon CloudWatch Logs in your account. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ExcludeVerboseContent` Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FieldLogLevel` The field logging level. Values can be NONE, ERROR, INFO, DEBUG, or ALL. + **NONE**: No field-level logs are captured. + **ERROR**: Logs the following information **only** for the fields that are in the error category: + The error section in the server response. + Field-level errors. + The generated request/response functions that got resolved for error fields. + **INFO**: Logs the following information **only** for the fields that are in the info and error categories: + Info-level messages. + The user messages sent through `$util.log.info` and `console.log`. + Field-level tracing and mapping logs are not shown. + **DEBUG**: Logs the following information **only** for the fields that are in the debug, info, and error categories: + Debug-level messages. + The user messages sent through `$util.log.info`, `$util.log.debug`, `console.log`, and `console.debug`. + Field-level tracing and mapping logs are not shown. + **ALL**: The following information is logged for all fields in the query: + Field-level tracing information. + The generated request/response functions that were resolved for each field. *Required*: Yes *Type*: String *Allowed values*: `NONE | ERROR | ALL | INFO | DEBUG` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppSync::GraphQLApi OpenIDConnectConfig The `OpenIDConnectConfig` property type specifies the optional authorization configuration for using an OpenID Connect compliant service with your GraphQL endpoint for an AWS AppSync GraphQL API. `OpenIDConnectConfig` is a property of the [AWS::AppSync::GraphQLApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html) property type. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AuthTTL](#cfn-appsync-graphqlapi-openidconnectconfig-authttl)" : Number, "[ClientId](#cfn-appsync-graphqlapi-openidconnectconfig-clientid)" : String, "[IatTTL](#cfn-appsync-graphqlapi-openidconnectconfig-iatttl)" : Number, "[Issuer](#cfn-appsync-graphqlapi-openidconnectconfig-issuer)" : String } ``` ### YAML ``` [AuthTTL](#cfn-appsync-graphqlapi-openidconnectconfig-authttl): Number [ClientId](#cfn-appsync-graphqlapi-openidconnectconfig-clientid): String [IatTTL](#cfn-appsync-graphqlapi-openidconnectconfig-iatttl): Number [Issuer](#cfn-appsync-graphqlapi-openidconnectconfig-issuer): String ``` ## Properties `AuthTTL` The number of milliseconds that a token is valid after being authenticated. *Required*: No *Type*: Number *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `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. *Required*: No *Type*: String *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `IatTTL` The number of milliseconds that a token is valid after it's issued to a user. *Required*: No *Type*: Number *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `Issuer` The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of `iss` in the ID token. *Required*: No *Type*: String *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) # AWS::AppSync::GraphQLApi Tag An arbitrary set of tags (key-value pairs) for this GraphQL API. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-appsync-graphqlapi-tag-key)" : String, "[Value](#cfn-appsync-graphqlapi-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-appsync-graphqlapi-tag-key): String [Value](#cfn-appsync-graphqlapi-tag-value): String ``` ## Properties `Key` Describes the key of the tag. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` Describes the value of the tag. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppSync::GraphQLApi UserPoolConfig The `UserPoolConfig` property type specifies the optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint for an AWS AppSync GraphQL API. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AppIdClientRegex](#cfn-appsync-graphqlapi-userpoolconfig-appidclientregex)" : String, "[AwsRegion](#cfn-appsync-graphqlapi-userpoolconfig-awsregion)" : String, "[DefaultAction](#cfn-appsync-graphqlapi-userpoolconfig-defaultaction)" : String, "[UserPoolId](#cfn-appsync-graphqlapi-userpoolconfig-userpoolid)" : String } ``` ### YAML ``` [AppIdClientRegex](#cfn-appsync-graphqlapi-userpoolconfig-appidclientregex): String [AwsRegion](#cfn-appsync-graphqlapi-userpoolconfig-awsregion): String [DefaultAction](#cfn-appsync-graphqlapi-userpoolconfig-defaultaction): String [UserPoolId](#cfn-appsync-graphqlapi-userpoolconfig-userpoolid): String ``` ## Properties `AppIdClientRegex` A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied. *Required*: No *Type*: String *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `AwsRegion` The AWS Region in which the user pool was created. *Required*: No *Type*: String *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `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. When specifying Amazon Cognito user pools as the default authentication, you must set the value for `DefaultAction` to `ALLOW` if specifying `AdditionalAuthenticationProviders`. *Required*: No *Type*: String *Allowed values*: `ALLOW | DENY` *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `UserPoolId` The user pool ID. *Required*: No *Type*: String *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)