aws-cdk-lib 2.141.0__py3-none-any.whl → 2.142.0__py3-none-any.whl

aws_cdk/__init__.py

@@ -264,7 +264,15 @@ In order to mimic strong references, a Custom Resource is also created in the co
 stack which marks the SSM parameters as being "imported". When a parameter has been successfully
 imported, the producing stack cannot update the value.
 
-See the [adr](https://github.com/aws/aws-cdk/blob/main/packages/@aws-cdk/core/adr/cross-region-stack-references)
+> [!NOTE]
+> As a consequence of this feature being built on a Custom Resource, we are restricted to a
+> CloudFormation response body size limitation of [4096 bytes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/crpg-ref-responses.html).
+> To prevent deployment errors related to the Custom Resource Provider response body being too
+> large, we recommend limiting the use of nested stacks and minimizing the length of stack names.
+> Doing this will prevent SSM parameter names from becoming too long which will reduce the size of the
+> response body.
+
+See the [adr](https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/core/adr/cross-region-stack-references.md)
 for more details on this feature.
 
 ### Removing automatic cross-stack references

aws_cdk/_jsii/__init__.py

@@ -19,7 +19,7 @@ import aws_cdk.asset_node_proxy_agent_v6._jsii
 import constructs._jsii
 
 __jsii_assembly__ = jsii.JSIIAssembly.load(
-    "aws-cdk-lib", "2.141.0", __name__[0:-6], "aws-cdk-lib@2.141.0.jsii.tgz"
+    "aws-cdk-lib", "2.142.0", __name__[0:-6], "aws-cdk-lib@2.142.0.jsii.tgz"
 )
 
 __all__ = [

aws_cdk/aws_appsync/__init__.py

@@ -869,6 +869,31 @@ api = appsync.GraphqlApi(self, "api",
 
 api.add_environment_variable("EnvKey2", "non-empty-2")
 ```
+
+## Configure an EventBridge target that invokes an AppSync GraphQL API
+
+Configuring the target relies on the `graphQLEndpointArn` property.
+
+Use the `AppSync` event target to trigger an AppSync GraphQL API. You need to
+create an `AppSync.GraphqlApi` configured with `AWS_IAM` authorization mode.
+
+The code snippet below creates a AppSync GraphQL API target that is invoked, calling the `publish` mutation.
+
+```python
+import aws_cdk.aws_events as events
+import aws_cdk.aws_events_targets as targets
+
+# rule: events.Rule
+# api: appsync.GraphqlApi
+
+
+rule.add_target(targets.AppSync(api,
+    graph_qLOperation="mutation Publish($message: String!){ publish(message: $message) { message } }",
+    variables=events.RuleTargetInput.from_object({
+        "message": "hello world"
+    })
+))
+```
 '''
 from pkgutil import extend_path
 __path__ = extend_path(__path__, __name__)
@@ -1282,22 +1307,27 @@ class AuthorizationConfig:
 
         Example::
 
-            import aws_cdk.aws_lambda as lambda_
-            # auth_function: lambda.Function
+            import aws_cdk.aws_appsync as appsync
             
             
-            appsync.GraphqlApi(self, "api",
+            api = appsync.GraphqlApi(self, "api",
                 name="api",
-                definition=appsync.Definition.from_file(path.join(__dirname, "appsync.test.graphql")),
+                definition=appsync.Definition.from_file("schema.graphql"),
                 authorization_config=appsync.AuthorizationConfig(
-                    default_authorization=appsync.AuthorizationMode(
-                        authorization_type=appsync.AuthorizationType.LAMBDA,
-                        lambda_authorizer_config=appsync.LambdaAuthorizerConfig(
-                            handler=auth_function
-                        )
-                    )
+                    default_authorization=appsync.AuthorizationMode(authorization_type=appsync.AuthorizationType.IAM)
                 )
             )
+            
+            rule = events.Rule(self, "Rule",
+                schedule=events.Schedule.rate(cdk.Duration.hours(1))
+            )
+            
+            rule.add_target(targets.AppSync(api,
+                graph_qLOperation="mutation Publish($message: String!){ publish(message: $message) { message } }",
+                variables=events.RuleTargetInput.from_object({
+                    "message": "hello world"
+                })
+            ))
         '''
         if isinstance(default_authorization, dict):
             default_authorization = AuthorizationMode(**default_authorization)
@@ -1376,53 +1406,27 @@ class AuthorizationMode:
 
         Example::
 
-            api = appsync.GraphqlApi(self, "Api",
-                name="demo",
-                definition=appsync.Definition.from_file(path.join(__dirname, "schema.graphql")),
-                authorization_config=appsync.AuthorizationConfig(
-                    default_authorization=appsync.AuthorizationMode(
-                        authorization_type=appsync.AuthorizationType.IAM
-                    )
-                ),
-                xray_enabled=True
-            )
+            import aws_cdk.aws_appsync as appsync
             
-            demo_table = dynamodb.Table(self, "DemoTable",
-                partition_key=dynamodb.Attribute(
-                    name="id",
-                    type=dynamodb.AttributeType.STRING
-                )
-            )
-            
-            demo_dS = api.add_dynamo_db_data_source("demoDataSource", demo_table)
             
-            # Resolver for the Query "getDemos" that scans the DynamoDb table and returns the entire list.
-            # Resolver Mapping Template Reference:
-            # https://docs.aws.amazon.com/appsync/latest/devguide/resolver-mapping-template-reference-dynamodb.html
-            demo_dS.create_resolver("QueryGetDemosResolver",
-                type_name="Query",
-                field_name="getDemos",
-                request_mapping_template=appsync.MappingTemplate.dynamo_db_scan_table(),
-                response_mapping_template=appsync.MappingTemplate.dynamo_db_result_list()
+            api = appsync.GraphqlApi(self, "api",
+                name="api",
+                definition=appsync.Definition.from_file("schema.graphql"),
+                authorization_config=appsync.AuthorizationConfig(
+                    default_authorization=appsync.AuthorizationMode(authorization_type=appsync.AuthorizationType.IAM)
+                )
             )
             
-            # Resolver for the Mutation "addDemo" that puts the item into the DynamoDb table.
-            demo_dS.create_resolver("MutationAddDemoResolver",
-                type_name="Mutation",
-                field_name="addDemo",
-                request_mapping_template=appsync.MappingTemplate.dynamo_db_put_item(
-                    appsync.PrimaryKey.partition("id").auto(),
-                    appsync.Values.projecting("input")),
-                response_mapping_template=appsync.MappingTemplate.dynamo_db_result_item()
+            rule = events.Rule(self, "Rule",
+                schedule=events.Schedule.rate(cdk.Duration.hours(1))
             )
             
-            # To enable DynamoDB read consistency with the `MappingTemplate`:
-            demo_dS.create_resolver("QueryGetDemosConsistentResolver",
-                type_name="Query",
-                field_name="getDemosConsistent",
-                request_mapping_template=appsync.MappingTemplate.dynamo_db_scan_table(True),
-                response_mapping_template=appsync.MappingTemplate.dynamo_db_result_list()
-            )
+            rule.add_target(targets.AppSync(api,
+                graph_qLOperation="mutation Publish($message: String!){ publish(message: $message) { message } }",
+                variables=events.RuleTargetInput.from_object({
+                    "message": "hello world"
+                })
+            ))
         '''
         if isinstance(api_key_config, dict):
             api_key_config = ApiKeyConfig(**api_key_config)
@@ -1519,53 +1523,31 @@ class AuthorizationType(enum.Enum):
 
     Example::
 
-        api = appsync.GraphqlApi(self, "Api",
-            name="demo",
-            definition=appsync.Definition.from_file(path.join(__dirname, "schema.graphql")),
-            authorization_config=appsync.AuthorizationConfig(
-                default_authorization=appsync.AuthorizationMode(
-                    authorization_type=appsync.AuthorizationType.IAM
-                )
-            ),
-            xray_enabled=True
-        )
+        import aws_cdk.aws_iam as iam
+        import aws_cdk.aws_appsync as appsync
         
-        demo_table = dynamodb.Table(self, "DemoTable",
-            partition_key=dynamodb.Attribute(
-                name="id",
-                type=dynamodb.AttributeType.STRING
-            )
-        )
         
-        demo_dS = api.add_dynamo_db_data_source("demoDataSource", demo_table)
-        
-        # Resolver for the Query "getDemos" that scans the DynamoDb table and returns the entire list.
-        # Resolver Mapping Template Reference:
-        # https://docs.aws.amazon.com/appsync/latest/devguide/resolver-mapping-template-reference-dynamodb.html
-        demo_dS.create_resolver("QueryGetDemosResolver",
-            type_name="Query",
-            field_name="getDemos",
-            request_mapping_template=appsync.MappingTemplate.dynamo_db_scan_table(),
-            response_mapping_template=appsync.MappingTemplate.dynamo_db_result_list()
+        api = appsync.GraphqlApi.from_graphql_api_attributes(self, "ImportedAPI",
+            graphql_api_id="<api-id>",
+            graphql_api_arn="<api-arn>",
+            graph_qLEndpoint_arn="<api-endpoint-arn>",
+            visibility=appsync.Visibility.GLOBAL,
+            modes=[appsync.AuthorizationType.IAM]
         )
         
-        # Resolver for the Mutation "addDemo" that puts the item into the DynamoDb table.
-        demo_dS.create_resolver("MutationAddDemoResolver",
-            type_name="Mutation",
-            field_name="addDemo",
-            request_mapping_template=appsync.MappingTemplate.dynamo_db_put_item(
-                appsync.PrimaryKey.partition("id").auto(),
-                appsync.Values.projecting("input")),
-            response_mapping_template=appsync.MappingTemplate.dynamo_db_result_item()
-        )
+        rule = events.Rule(self, "Rule", schedule=events.Schedule.rate(cdk.Duration.minutes(1)))
+        role = iam.Role(self, "Role", assumed_by=iam.ServicePrincipal("events.amazonaws.com"))
         
-        # To enable DynamoDB read consistency with the `MappingTemplate`:
-        demo_dS.create_resolver("QueryGetDemosConsistentResolver",
-            type_name="Query",
-            field_name="getDemosConsistent",
-            request_mapping_template=appsync.MappingTemplate.dynamo_db_scan_table(True),
-            response_mapping_template=appsync.MappingTemplate.dynamo_db_result_list()
-        )
+        # allow EventBridge to use the `publish` mutation
+        api.grant_mutation(role, "publish")
+        
+        rule.add_target(targets.AppSync(api,
+            graph_qLOperation="mutation Publish($message: String!){ publish(message: $message) { message } }",
+            variables=events.RuleTargetInput.from_object({
+                "message": "hello world"
+            }),
+            event_role=role
+        ))
     '''
 
     API_KEY = "API_KEY"
@@ -10692,6 +10674,9 @@ class FunctionRuntimeFamily(enum.Enum):
     name_mapping={
         "graphql_api_id": "graphqlApiId",
         "graphql_api_arn": "graphqlApiArn",
+        "graph_ql_endpoint_arn": "graphQLEndpointArn",
+        "modes": "modes",
+        "visibility": "visibility",
     },
 )
 class GraphqlApiAttributes:
@@ -10700,11 +10685,17 @@ class GraphqlApiAttributes:
         *,
         graphql_api_id: builtins.str,
         graphql_api_arn: typing.Optional[builtins.str] = None,
+        graph_ql_endpoint_arn: typing.Optional[builtins.str] = None,
+        modes: typing.Optional[typing.Sequence[AuthorizationType]] = None,
+        visibility: typing.Optional["Visibility"] = None,
     ) -> None:
         '''Attributes for GraphQL imports.
 
         :param graphql_api_id: an unique AWS AppSync GraphQL API identifier i.e. 'lxz775lwdrgcndgz3nurvac7oa'.
         :param graphql_api_arn: the arn for the GraphQL Api. Default: - autogenerated arn
+        :param graph_ql_endpoint_arn: The GraphQl endpoint arn for the GraphQL API. Default: - none, required to construct event rules from imported APIs
+        :param modes: The Authorization Types for this GraphQL Api. Default: - none, required to construct event rules from imported APIs
+        :param visibility: The GraphQl API visibility. Default: - GLOBAL
 
         :exampleMetadata: infused
 
@@ -10732,11 +10723,20 @@ class GraphqlApiAttributes:
             type_hints = typing.get_type_hints(_typecheckingstub__ec1fc91e210b45240155885dae82dd53ddc084048aae2724cd942ec7c5202c10)
             check_type(argname="argument graphql_api_id", value=graphql_api_id, expected_type=type_hints["graphql_api_id"])
             check_type(argname="argument graphql_api_arn", value=graphql_api_arn, expected_type=type_hints["graphql_api_arn"])
+            check_type(argname="argument graph_ql_endpoint_arn", value=graph_ql_endpoint_arn, expected_type=type_hints["graph_ql_endpoint_arn"])
+            check_type(argname="argument modes", value=modes, expected_type=type_hints["modes"])
+            check_type(argname="argument visibility", value=visibility, expected_type=type_hints["visibility"])
         self._values: typing.Dict[builtins.str, typing.Any] = {
             "graphql_api_id": graphql_api_id,
         }
         if graphql_api_arn is not None:
             self._values["graphql_api_arn"] = graphql_api_arn
+        if graph_ql_endpoint_arn is not None:
+            self._values["graph_ql_endpoint_arn"] = graph_ql_endpoint_arn
+        if modes is not None:
+            self._values["modes"] = modes
+        if visibility is not None:
+            self._values["visibility"] = visibility
 
     @builtins.property
     def graphql_api_id(self) -> builtins.str:
@@ -10754,6 +10754,33 @@ class GraphqlApiAttributes:
         result = self._values.get("graphql_api_arn")
         return typing.cast(typing.Optional[builtins.str], result)
 
+    @builtins.property
+    def graph_ql_endpoint_arn(self) -> typing.Optional[builtins.str]:
+        '''The GraphQl endpoint arn for the GraphQL API.
+
+        :default: - none, required to construct event rules from imported APIs
+        '''
+        result = self._values.get("graph_ql_endpoint_arn")
+        return typing.cast(typing.Optional[builtins.str], result)
+
+    @builtins.property
+    def modes(self) -> typing.Optional[typing.List[AuthorizationType]]:
+        '''The Authorization Types for this GraphQL Api.
+
+        :default: - none, required to construct event rules from imported APIs
+        '''
+        result = self._values.get("modes")
+        return typing.cast(typing.Optional[typing.List[AuthorizationType]], result)
+
+    @builtins.property
+    def visibility(self) -> typing.Optional["Visibility"]:
+        '''The GraphQl API visibility.
+
+        :default: - GLOBAL
+        '''
+        result = self._values.get("visibility")
+        return typing.cast(typing.Optional["Visibility"], result)
+
     def __eq__(self, rhs: typing.Any) -> builtins.bool:
         return isinstance(rhs, self.__class__) and rhs._values == self._values
 
@@ -11323,6 +11350,24 @@ class IGraphqlApi(_IResource_c80c4260, typing_extensions.Protocol):
         '''
         ...
 
+    @builtins.property
+    @jsii.member(jsii_name="graphQLEndpointArn")
+    def graph_ql_endpoint_arn(self) -> builtins.str:
+        '''The GraphQL endpoint ARN.'''
+        ...
+
+    @builtins.property
+    @jsii.member(jsii_name="modes")
+    def modes(self) -> typing.List[AuthorizationType]:
+        '''The Authorization Types for this GraphQL Api.'''
+        ...
+
+    @builtins.property
+    @jsii.member(jsii_name="visibility")
+    def visibility(self) -> "Visibility":
+        '''the visibility of the API.'''
+        ...
+
     @jsii.member(jsii_name="addDynamoDbDataSource")
     def add_dynamo_db_data_source(
         self,
@@ -11620,6 +11665,24 @@ class _IGraphqlApiProxy(
         '''
         return typing.cast(builtins.str, jsii.get(self, "arn"))
 
+    @builtins.property
+    @jsii.member(jsii_name="graphQLEndpointArn")
+    def graph_ql_endpoint_arn(self) -> builtins.str:
+        '''The GraphQL endpoint ARN.'''
+        return typing.cast(builtins.str, jsii.get(self, "graphQLEndpointArn"))
+
+    @builtins.property
+    @jsii.member(jsii_name="modes")
+    def modes(self) -> typing.List[AuthorizationType]:
+        '''The Authorization Types for this GraphQL Api.'''
+        return typing.cast(typing.List[AuthorizationType], jsii.get(self, "modes"))
+
+    @builtins.property
+    @jsii.member(jsii_name="visibility")
+    def visibility(self) -> "Visibility":
+        '''the visibility of the API.'''
+        return typing.cast("Visibility", jsii.get(self, "visibility"))
+
     @jsii.member(jsii_name="addDynamoDbDataSource")
     def add_dynamo_db_data_source(
         self,
@@ -16336,6 +16399,27 @@ class GraphqlApiBase(
         '''the ARN of the API.'''
         ...
 
+    @builtins.property
+    @jsii.member(jsii_name="graphQLEndpointArn")
+    @abc.abstractmethod
+    def graph_ql_endpoint_arn(self) -> builtins.str:
+        '''The GraphQL endpoint ARN.'''
+        ...
+
+    @builtins.property
+    @jsii.member(jsii_name="modes")
+    @abc.abstractmethod
+    def modes(self) -> typing.List[AuthorizationType]:
+        '''The Authorization Types for this GraphQL Api.'''
+        ...
+
+    @builtins.property
+    @jsii.member(jsii_name="visibility")
+    @abc.abstractmethod
+    def visibility(self) -> Visibility:
+        '''The visibility of the API.'''
+        ...
+
 
 class _GraphqlApiBaseProxy(
     GraphqlApiBase,
@@ -16353,6 +16437,24 @@ class _GraphqlApiBaseProxy(
         '''the ARN of the API.'''
         return typing.cast(builtins.str, jsii.get(self, "arn"))
 
+    @builtins.property
+    @jsii.member(jsii_name="graphQLEndpointArn")
+    def graph_ql_endpoint_arn(self) -> builtins.str:
+        '''The GraphQL endpoint ARN.'''
+        return typing.cast(builtins.str, jsii.get(self, "graphQLEndpointArn"))
+
+    @builtins.property
+    @jsii.member(jsii_name="modes")
+    def modes(self) -> typing.List[AuthorizationType]:
+        '''The Authorization Types for this GraphQL Api.'''
+        return typing.cast(typing.List[AuthorizationType], jsii.get(self, "modes"))
+
+    @builtins.property
+    @jsii.member(jsii_name="visibility")
+    def visibility(self) -> Visibility:
+        '''The visibility of the API.'''
+        return typing.cast(Visibility, jsii.get(self, "visibility"))
+
 # Adding a "__jsii_proxy_class__(): typing.Type" function to the abstract class
 typing.cast(typing.Any, GraphqlApiBase).__jsii_proxy_class__ = lambda : _GraphqlApiBaseProxy
 
@@ -17386,6 +17488,9 @@ class GraphqlApi(
         *,
         graphql_api_id: builtins.str,
         graphql_api_arn: typing.Optional[builtins.str] = None,
+        graph_ql_endpoint_arn: typing.Optional[builtins.str] = None,
+        modes: typing.Optional[typing.Sequence[AuthorizationType]] = None,
+        visibility: typing.Optional[Visibility] = None,
     ) -> IGraphqlApi:
         '''Import a GraphQL API through this function.
 
@@ -17393,13 +17498,20 @@ class GraphqlApi(
         :param id: id.
         :param graphql_api_id: an unique AWS AppSync GraphQL API identifier i.e. 'lxz775lwdrgcndgz3nurvac7oa'.
         :param graphql_api_arn: the arn for the GraphQL Api. Default: - autogenerated arn
+        :param graph_ql_endpoint_arn: The GraphQl endpoint arn for the GraphQL API. Default: - none, required to construct event rules from imported APIs
+        :param modes: The Authorization Types for this GraphQL Api. Default: - none, required to construct event rules from imported APIs
+        :param visibility: The GraphQl API visibility. Default: - GLOBAL
         '''
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__5cefbac91e5bf4b599b8cb612f2e49280f0cab47fab8b476b11f991f6c9f42f4)
             check_type(argname="argument scope", value=scope, expected_type=type_hints["scope"])
             check_type(argname="argument id", value=id, expected_type=type_hints["id"])
         attrs = GraphqlApiAttributes(
-            graphql_api_id=graphql_api_id, graphql_api_arn=graphql_api_arn
+            graphql_api_id=graphql_api_id,
+            graphql_api_arn=graphql_api_arn,
+            graph_ql_endpoint_arn=graph_ql_endpoint_arn,
+            modes=modes,
+            visibility=visibility,
         )
 
         return typing.cast(IGraphqlApi, jsii.sinvoke(cls, "fromGraphqlApiAttributes", [scope, id, attrs]))
@@ -17446,6 +17558,12 @@ class GraphqlApi(
         '''the ARN of the API.'''
         return typing.cast(builtins.str, jsii.get(self, "arn"))
 
+    @builtins.property
+    @jsii.member(jsii_name="graphQLEndpointArn")
+    def graph_ql_endpoint_arn(self) -> builtins.str:
+        '''The GraphQL endpoint ARN.'''
+        return typing.cast(builtins.str, jsii.get(self, "graphQLEndpointArn"))
+
     @builtins.property
     @jsii.member(jsii_name="graphqlUrl")
     def graphql_url(self) -> builtins.str:
@@ -17479,6 +17597,12 @@ class GraphqlApi(
         '''the schema attached to this api (only available for GraphQL APIs, not available for merged APIs).'''
         return typing.cast(ISchema, jsii.get(self, "schema"))
 
+    @builtins.property
+    @jsii.member(jsii_name="visibility")
+    def visibility(self) -> Visibility:
+        '''the visibility of the API.'''
+        return typing.cast(Visibility, jsii.get(self, "visibility"))
+
     @builtins.property
     @jsii.member(jsii_name="apiKey")
     def api_key(self) -> typing.Optional[builtins.str]:
@@ -19048,6 +19172,9 @@ def _typecheckingstub__ec1fc91e210b45240155885dae82dd53ddc084048aae2724cd942ec7c
     *,
     graphql_api_id: builtins.str,
     graphql_api_arn: typing.Optional[builtins.str] = None,
+    graph_ql_endpoint_arn: typing.Optional[builtins.str] = None,
+    modes: typing.Optional[typing.Sequence[AuthorizationType]] = None,
+    visibility: typing.Optional[Visibility] = None,
 ) -> None:
     """Type checking stubs"""
     pass
@@ -20095,6 +20222,9 @@ def _typecheckingstub__5cefbac91e5bf4b599b8cb612f2e49280f0cab47fab8b476b11f991f6
     *,
     graphql_api_id: builtins.str,
     graphql_api_arn: typing.Optional[builtins.str] = None,
+    graph_ql_endpoint_arn: typing.Optional[builtins.str] = None,
+    modes: typing.Optional[typing.Sequence[AuthorizationType]] = None,
+    visibility: typing.Optional[Visibility] = None,
 ) -> None:
     """Type checking stubs"""
     pass