aws-cdk-lib 2.133.0__py3-none-any.whl → 2.135.0__py3-none-any.whl

aws_cdk/aws_appsync/__init__.py

@@ -757,6 +757,33 @@ api = appsync.GraphqlApi(self, "api",
 )
 ```
 
+## Query Depth Limits
+
+By default, queries are able to process an unlimited amount of nested levels.
+Limiting queries to a specified amount of nested levels has potential implications for the performance and flexibility of your project.
+
+```python
+api = appsync.GraphqlApi(self, "api",
+    name="LimitQueryDepths",
+    definition=appsync.Definition.from_file(path.join(__dirname, "appsync.schema.graphql")),
+    query_depth_limit=2
+)
+```
+
+## Resolver Count Limits
+
+You can control how many resolvers each query can process.
+By default, each query can process up to 10000 resolvers.
+By setting a limit AppSync will not handle any resolvers past a certain number limit.
+
+```python
+api = appsync.GraphqlApi(self, "api",
+    name="LimitResolverCount",
+    definition=appsync.Definition.from_file(path.join(__dirname, "appsync.schema.graphql")),
+    resolver_count_limit=2
+)
+```
+
 ## Environment Variables
 
 To use environment variables in resolvers, you can use the `environmentVariables` property and
@@ -774,6 +801,9 @@ api = appsync.GraphqlApi(self, "api",
 api.add_environment_variable("EnvKey2", "non-empty-2")
 ```
 '''
+from pkgutil import extend_path
+__path__ = extend_path(__path__, __name__)
+
 import abc
 import builtins
 import datetime
@@ -10675,6 +10705,8 @@ class GraphqlApiAttributes:
         "environment_variables": "environmentVariables",
         "introspection_config": "introspectionConfig",
         "log_config": "logConfig",
+        "query_depth_limit": "queryDepthLimit",
+        "resolver_count_limit": "resolverCountLimit",
         "schema": "schema",
         "visibility": "visibility",
         "xray_enabled": "xrayEnabled",
@@ -10691,6 +10723,8 @@ class GraphqlApiProps:
         environment_variables: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
         introspection_config: typing.Optional["IntrospectionConfig"] = None,
         log_config: typing.Optional[typing.Union["LogConfig", typing.Dict[builtins.str, typing.Any]]] = None,
+        query_depth_limit: typing.Optional[jsii.Number] = None,
+        resolver_count_limit: typing.Optional[jsii.Number] = None,
         schema: typing.Optional["ISchema"] = None,
         visibility: typing.Optional["Visibility"] = None,
         xray_enabled: typing.Optional[builtins.bool] = None,
@@ -10704,6 +10738,8 @@ class GraphqlApiProps:
         :param environment_variables: A map containing the list of resources with their properties and environment variables. There are a few rules you must follow when creating keys and values: - Keys must begin with a letter. - Keys must be between 2 and 64 characters long. - Keys can only contain letters, numbers, and the underscore character (_). - Values can be up to 512 characters long. - You can configure up to 50 key-value pairs in a GraphQL API. Default: - No environment variables.
         :param introspection_config: A value indicating whether the API to enable (ENABLED) or disable (DISABLED) introspection. Default: IntrospectionConfig.ENABLED
         :param log_config: Logging configuration for this api. Default: - None
+        :param query_depth_limit: A number indicating the maximum depth resolvers should be accepted when handling queries. Value must be withing range of 0 to 75 Default: - The default value is 0 (or unspecified) which indicates no maximum depth.
+        :param resolver_count_limit: A number indicating the maximum number of resolvers that should be accepted when handling queries. Value must be withing range of 0 to 10000 Default: - The default value is 0 (or unspecified), which will set the limit to 10000
         :param schema: (deprecated) GraphQL schema definition. Specify how you want to define your schema. SchemaFile.fromAsset(filePath: string) allows schema definition through schema.graphql file Default: - schema will be generated code-first (i.e. addType, addObjectType, etc.)
         :param visibility: A value indicating whether the API is accessible from anywhere (GLOBAL) or can only be access from a VPC (PRIVATE). Default: - GLOBAL
         :param xray_enabled: A flag indicating whether or not X-Ray tracing is enabled for the GraphQL API. Default: - false
@@ -10745,6 +10781,8 @@ class GraphqlApiProps:
             check_type(argname="argument environment_variables", value=environment_variables, expected_type=type_hints["environment_variables"])
             check_type(argname="argument introspection_config", value=introspection_config, expected_type=type_hints["introspection_config"])
             check_type(argname="argument log_config", value=log_config, expected_type=type_hints["log_config"])
+            check_type(argname="argument query_depth_limit", value=query_depth_limit, expected_type=type_hints["query_depth_limit"])
+            check_type(argname="argument resolver_count_limit", value=resolver_count_limit, expected_type=type_hints["resolver_count_limit"])
             check_type(argname="argument schema", value=schema, expected_type=type_hints["schema"])
             check_type(argname="argument visibility", value=visibility, expected_type=type_hints["visibility"])
             check_type(argname="argument xray_enabled", value=xray_enabled, expected_type=type_hints["xray_enabled"])
@@ -10763,6 +10801,10 @@ class GraphqlApiProps:
             self._values["introspection_config"] = introspection_config
         if log_config is not None:
             self._values["log_config"] = log_config
+        if query_depth_limit is not None:
+            self._values["query_depth_limit"] = query_depth_limit
+        if resolver_count_limit is not None:
+            self._values["resolver_count_limit"] = resolver_count_limit
         if schema is not None:
             self._values["schema"] = schema
         if visibility is not None:
@@ -10841,6 +10883,28 @@ class GraphqlApiProps:
         result = self._values.get("log_config")
         return typing.cast(typing.Optional["LogConfig"], result)
 
+    @builtins.property
+    def query_depth_limit(self) -> typing.Optional[jsii.Number]:
+        '''A number indicating the maximum depth resolvers should be accepted when handling queries.
+
+        Value must be withing range of 0 to 75
+
+        :default: - The default value is 0 (or unspecified) which indicates no maximum depth.
+        '''
+        result = self._values.get("query_depth_limit")
+        return typing.cast(typing.Optional[jsii.Number], result)
+
+    @builtins.property
+    def resolver_count_limit(self) -> typing.Optional[jsii.Number]:
+        '''A number indicating the maximum number of resolvers that should be accepted when handling queries.
+
+        Value must be withing range of 0 to 10000
+
+        :default: - The default value is 0 (or unspecified), which will set the limit to 10000
+        '''
+        result = self._values.get("resolver_count_limit")
+        return typing.cast(typing.Optional[jsii.Number], result)
+
     @builtins.property
     def schema(self) -> typing.Optional["ISchema"]:
         '''(deprecated) GraphQL schema definition. Specify how you want to define your schema.
@@ -16921,6 +16985,8 @@ class GraphqlApi(
         environment_variables: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
         introspection_config: typing.Optional[IntrospectionConfig] = None,
         log_config: typing.Optional[typing.Union[LogConfig, typing.Dict[builtins.str, typing.Any]]] = None,
+        query_depth_limit: typing.Optional[jsii.Number] = None,
+        resolver_count_limit: typing.Optional[jsii.Number] = None,
         schema: typing.Optional[ISchema] = None,
         visibility: typing.Optional[Visibility] = None,
         xray_enabled: typing.Optional[builtins.bool] = None,
@@ -16935,6 +17001,8 @@ class GraphqlApi(
         :param environment_variables: A map containing the list of resources with their properties and environment variables. There are a few rules you must follow when creating keys and values: - Keys must begin with a letter. - Keys must be between 2 and 64 characters long. - Keys can only contain letters, numbers, and the underscore character (_). - Values can be up to 512 characters long. - You can configure up to 50 key-value pairs in a GraphQL API. Default: - No environment variables.
         :param introspection_config: A value indicating whether the API to enable (ENABLED) or disable (DISABLED) introspection. Default: IntrospectionConfig.ENABLED
         :param log_config: Logging configuration for this api. Default: - None
+        :param query_depth_limit: A number indicating the maximum depth resolvers should be accepted when handling queries. Value must be withing range of 0 to 75 Default: - The default value is 0 (or unspecified) which indicates no maximum depth.
+        :param resolver_count_limit: A number indicating the maximum number of resolvers that should be accepted when handling queries. Value must be withing range of 0 to 10000 Default: - The default value is 0 (or unspecified), which will set the limit to 10000
         :param schema: (deprecated) GraphQL schema definition. Specify how you want to define your schema. SchemaFile.fromAsset(filePath: string) allows schema definition through schema.graphql file Default: - schema will be generated code-first (i.e. addType, addObjectType, etc.)
         :param visibility: A value indicating whether the API is accessible from anywhere (GLOBAL) or can only be access from a VPC (PRIVATE). Default: - GLOBAL
         :param xray_enabled: A flag indicating whether or not X-Ray tracing is enabled for the GraphQL API. Default: - false
@@ -16951,6 +17019,8 @@ class GraphqlApi(
             environment_variables=environment_variables,
             introspection_config=introspection_config,
             log_config=log_config,
+            query_depth_limit=query_depth_limit,
+            resolver_count_limit=resolver_count_limit,
             schema=schema,
             visibility=visibility,
             xray_enabled=xray_enabled,
@@ -18641,6 +18711,8 @@ def _typecheckingstub__99ac2113ba86b3a60344e56ee0c5bb6cdf1bc20cd0d5aa52f9a94709f
     environment_variables: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
     introspection_config: typing.Optional[IntrospectionConfig] = None,
     log_config: typing.Optional[typing.Union[LogConfig, typing.Dict[builtins.str, typing.Any]]] = None,
+    query_depth_limit: typing.Optional[jsii.Number] = None,
+    resolver_count_limit: typing.Optional[jsii.Number] = None,
     schema: typing.Optional[ISchema] = None,
     visibility: typing.Optional[Visibility] = None,
     xray_enabled: typing.Optional[builtins.bool] = None,
@@ -19621,6 +19693,8 @@ def _typecheckingstub__cdc21261f45618890d843fff7978e6e8e4f4cfe7884c4fffbff6b8dad
     environment_variables: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
     introspection_config: typing.Optional[IntrospectionConfig] = None,
     log_config: typing.Optional[typing.Union[LogConfig, typing.Dict[builtins.str, typing.Any]]] = None,
+    query_depth_limit: typing.Optional[jsii.Number] = None,
+    resolver_count_limit: typing.Optional[jsii.Number] = None,
     schema: typing.Optional[ISchema] = None,
     visibility: typing.Optional[Visibility] = None,
     xray_enabled: typing.Optional[builtins.bool] = None,