aws-cdk-lib 2.136.1__py3-none-any.whl → 2.138.0__py3-none-any.whl

aws_cdk/aws_appsync/__init__.py

@@ -91,6 +91,8 @@ AppSync provides a data source for executing SQL commands against Amazon Aurora
 Serverless clusters. You can use AppSync resolvers to execute SQL statements
 against the Data API with GraphQL queries, mutations, and subscriptions.
 
+#### Aurora Serverless V1 Cluster
+
 ```python
 # Build a data source for AppSync to access the database.
 # api: appsync.GraphqlApi
@@ -152,6 +154,73 @@ rds_dS.create_resolver("MutationAddDemoRdsResolver",
 )
 ```
 
+#### Aurora Serverless V2 Cluster
+
+```python
+# Build a data source for AppSync to access the database.
+# api: appsync.GraphqlApi
+# Create username and password secret for DB Cluster
+secret = rds.DatabaseSecret(self, "AuroraSecret",
+    username="clusteradmin"
+)
+
+# The VPC to place the cluster in
+vpc = ec2.Vpc(self, "AuroraVpc")
+
+# Create the serverless cluster, provide all values needed to customise the database.
+cluster = rds.DatabaseCluster(self, "AuroraClusterV2",
+    engine=rds.DatabaseClusterEngine.aurora_postgres(version=rds.AuroraPostgresEngineVersion.VER_15_5),
+    credentials={"username": "clusteradmin"},
+    cluster_identifier="db-endpoint-test",
+    writer=rds.ClusterInstance.serverless_v2("writer"),
+    serverless_v2_min_capacity=2,
+    serverless_v2_max_capacity=10,
+    vpc=vpc,
+    default_database_name="demos",
+    enable_data_api=True
+)
+rds_dS = api.add_rds_data_source_v2("rds", cluster, secret, "demos")
+
+# Set up a resolver for an RDS query.
+rds_dS.create_resolver("QueryGetDemosRdsResolver",
+    type_name="Query",
+    field_name="getDemosRds",
+    request_mapping_template=appsync.MappingTemplate.from_string("""
+          {
+            "version": "2018-05-29",
+            "statements": [
+              "SELECT * FROM demos"
+            ]
+          }
+          """),
+    response_mapping_template=appsync.MappingTemplate.from_string("""
+            $utils.toJson($utils.rds.toJsonObject($ctx.result)[0])
+          """)
+)
+
+# Set up a resolver for an RDS mutation.
+rds_dS.create_resolver("MutationAddDemoRdsResolver",
+    type_name="Mutation",
+    field_name="addDemoRds",
+    request_mapping_template=appsync.MappingTemplate.from_string("""
+          {
+            "version": "2018-05-29",
+            "statements": [
+              "INSERT INTO demos VALUES (:id, :version)",
+              "SELECT * WHERE id = :id"
+            ],
+            "variableMap": {
+              ":id": $util.toJson($util.autoId()),
+              ":version": $util.toJson($ctx.args.version)
+            }
+          }
+          """),
+    response_mapping_template=appsync.MappingTemplate.from_string("""
+            $utils.toJson($utils.rds.toJsonObject($ctx.result)[1][0])
+          """)
+)
+```
+
 ### HTTP Endpoints
 
 GraphQL schema file `schema.graphql`:
@@ -854,7 +923,10 @@ from ..aws_logs import (
     ILogGroup as _ILogGroup_3c4fa718, RetentionDays as _RetentionDays_070f99f0
 )
 from ..aws_opensearchservice import IDomain as _IDomain_3c13cbdd
-from ..aws_rds import IServerlessCluster as _IServerlessCluster_adbbb720
+from ..aws_rds import (
+    IDatabaseCluster as _IDatabaseCluster_6554c32b,
+    IServerlessCluster as _IServerlessCluster_adbbb720,
+)
 from ..aws_s3_assets import AssetOptions as _AssetOptions_2aa69621
 from ..aws_secretsmanager import ISecret as _ISecret_6e020e6a
 
@@ -11406,6 +11478,28 @@ class IGraphqlApi(_IResource_c80c4260, typing_extensions.Protocol):
         '''
         ...
 
+    @jsii.member(jsii_name="addRdsDataSourceV2")
+    def add_rds_data_source_v2(
+        self,
+        id: builtins.str,
+        serverless_cluster: _IDatabaseCluster_6554c32b,
+        secret_store: _ISecret_6e020e6a,
+        database_name: typing.Optional[builtins.str] = None,
+        *,
+        description: typing.Optional[builtins.str] = None,
+        name: typing.Optional[builtins.str] = None,
+    ) -> "RdsDataSource":
+        '''add a new Rds Serverless V2 data source to this API.
+
+        :param id: The data source's id.
+        :param serverless_cluster: The serverless V2 cluster to interact with this data source.
+        :param secret_store: The secret store that contains the username and password for the serverless cluster.
+        :param database_name: The optional name of the database to use within the cluster.
+        :param description: The description of the data source. Default: - No description
+        :param name: The name of the data source, overrides the id given by cdk. Default: - generated by cdk given the id
+        '''
+        ...
+
     @jsii.member(jsii_name="addSchemaDependency")
     def add_schema_dependency(self, construct: _CfnResource_9df397a6) -> builtins.bool:
         '''Add schema dependency if not imported.
@@ -11734,6 +11828,36 @@ class _IGraphqlApiProxy(
 
         return typing.cast("RdsDataSource", jsii.invoke(self, "addRdsDataSource", [id, serverless_cluster, secret_store, database_name, options]))
 
+    @jsii.member(jsii_name="addRdsDataSourceV2")
+    def add_rds_data_source_v2(
+        self,
+        id: builtins.str,
+        serverless_cluster: _IDatabaseCluster_6554c32b,
+        secret_store: _ISecret_6e020e6a,
+        database_name: typing.Optional[builtins.str] = None,
+        *,
+        description: typing.Optional[builtins.str] = None,
+        name: typing.Optional[builtins.str] = None,
+    ) -> "RdsDataSource":
+        '''add a new Rds Serverless V2 data source to this API.
+
+        :param id: The data source's id.
+        :param serverless_cluster: The serverless V2 cluster to interact with this data source.
+        :param secret_store: The secret store that contains the username and password for the serverless cluster.
+        :param database_name: The optional name of the database to use within the cluster.
+        :param description: The description of the data source. Default: - No description
+        :param name: The name of the data source, overrides the id given by cdk. Default: - generated by cdk given the id
+        '''
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__61bc6fb619aeb960346b149372d6f08ad695a7fb87cd5ad9ed2cbcb5146b60f3)
+            check_type(argname="argument id", value=id, expected_type=type_hints["id"])
+            check_type(argname="argument serverless_cluster", value=serverless_cluster, expected_type=type_hints["serverless_cluster"])
+            check_type(argname="argument secret_store", value=secret_store, expected_type=type_hints["secret_store"])
+            check_type(argname="argument database_name", value=database_name, expected_type=type_hints["database_name"])
+        options = DataSourceOptions(description=description, name=name)
+
+        return typing.cast("RdsDataSource", jsii.invoke(self, "addRdsDataSourceV2", [id, serverless_cluster, secret_store, database_name, options]))
+
     @jsii.member(jsii_name="addSchemaDependency")
     def add_schema_dependency(self, construct: _CfnResource_9df397a6) -> builtins.bool:
         '''Add schema dependency if not imported.
@@ -12531,23 +12655,63 @@ class MappingTemplate(
 
     Example::
 
-        import aws_cdk.aws_events as events
+        # Build a data source for AppSync to access the database.
+        # api: appsync.GraphqlApi
+        # Create username and password secret for DB Cluster
+        secret = rds.DatabaseSecret(self, "AuroraSecret",
+            username="clusteradmin"
+        )
         
+        # The VPC to place the cluster in
+        vpc = ec2.Vpc(self, "AuroraVpc")
         
-        api = appsync.GraphqlApi(self, "EventBridgeApi",
-            name="EventBridgeApi",
-            definition=appsync.Definition.from_file(path.join(__dirname, "appsync.eventbridge.graphql"))
+        # Create the serverless cluster, provide all values needed to customise the database.
+        cluster = rds.ServerlessCluster(self, "AuroraCluster",
+            engine=rds.DatabaseClusterEngine.AURORA_MYSQL,
+            vpc=vpc,
+            credentials={"username": "clusteradmin"},
+            cluster_identifier="db-endpoint-test",
+            default_database_name="demos"
         )
+        rds_dS = api.add_rds_data_source("rds", cluster, secret, "demos")
         
-        bus = events.EventBus(self, "DestinationEventBus")
-        
-        data_source = api.add_event_bridge_data_source("NoneDS", bus)
+        # Set up a resolver for an RDS query.
+        rds_dS.create_resolver("QueryGetDemosRdsResolver",
+            type_name="Query",
+            field_name="getDemosRds",
+            request_mapping_template=appsync.MappingTemplate.from_string("""
+                  {
+                    "version": "2018-05-29",
+                    "statements": [
+                      "SELECT * FROM demos"
+                    ]
+                  }
+                  """),
+            response_mapping_template=appsync.MappingTemplate.from_string("""
+                    $utils.toJson($utils.rds.toJsonObject($ctx.result)[0])
+                  """)
+        )
         
-        data_source.create_resolver("EventResolver",
+        # Set up a resolver for an RDS mutation.
+        rds_dS.create_resolver("MutationAddDemoRdsResolver",
             type_name="Mutation",
-            field_name="emitEvent",
-            request_mapping_template=appsync.MappingTemplate.from_file("request.vtl"),
-            response_mapping_template=appsync.MappingTemplate.from_file("response.vtl")
+            field_name="addDemoRds",
+            request_mapping_template=appsync.MappingTemplate.from_string("""
+                  {
+                    "version": "2018-05-29",
+                    "statements": [
+                      "INSERT INTO demos VALUES (:id, :version)",
+                      "SELECT * WHERE id = :id"
+                    ],
+                    "variableMap": {
+                      ":id": $util.toJson($util.autoId()),
+                      ":version": $util.toJson($ctx.args.version)
+                    }
+                  }
+                  """),
+            response_mapping_template=appsync.MappingTemplate.from_string("""
+                    $utils.toJson($utils.rds.toJsonObject($ctx.result)[1][0])
+                  """)
         )
     '''
 
@@ -15998,6 +16162,36 @@ class GraphqlApiBase(
 
         return typing.cast("RdsDataSource", jsii.invoke(self, "addRdsDataSource", [id, serverless_cluster, secret_store, database_name, options]))
 
+    @jsii.member(jsii_name="addRdsDataSourceV2")
+    def add_rds_data_source_v2(
+        self,
+        id: builtins.str,
+        serverless_cluster: _IDatabaseCluster_6554c32b,
+        secret_store: _ISecret_6e020e6a,
+        database_name: typing.Optional[builtins.str] = None,
+        *,
+        description: typing.Optional[builtins.str] = None,
+        name: typing.Optional[builtins.str] = None,
+    ) -> "RdsDataSource":
+        '''add a new Rds data source to this API.
+
+        :param id: The data source's id.
+        :param serverless_cluster: The serverless V2 cluster to interact with this data source.
+        :param secret_store: The secret store that contains the username and password for the serverless cluster.
+        :param database_name: The optional name of the database to use within the cluster.
+        :param description: The description of the data source. Default: - No description
+        :param name: The name of the data source, overrides the id given by cdk. Default: - generated by cdk given the id
+        '''
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__0d4d8935d69e29b6975caad596c95628af13c6b8e33430de6530665203cf5ef8)
+            check_type(argname="argument id", value=id, expected_type=type_hints["id"])
+            check_type(argname="argument serverless_cluster", value=serverless_cluster, expected_type=type_hints["serverless_cluster"])
+            check_type(argname="argument secret_store", value=secret_store, expected_type=type_hints["secret_store"])
+            check_type(argname="argument database_name", value=database_name, expected_type=type_hints["database_name"])
+        options = DataSourceOptions(description=description, name=name)
+
+        return typing.cast("RdsDataSource", jsii.invoke(self, "addRdsDataSourceV2", [id, serverless_cluster, secret_store, database_name, options]))
+
     @jsii.member(jsii_name="addSchemaDependency")
     def add_schema_dependency(self, construct: _CfnResource_9df397a6) -> builtins.bool:
         '''Add schema dependency if not imported.
@@ -16811,7 +17005,7 @@ class RdsDataSourceProps(BackedDataSourceProps):
         serverless_cluster: _IServerlessCluster_adbbb720,
         database_name: typing.Optional[builtins.str] = None,
     ) -> None:
-        '''Properties for an AppSync RDS datasource.
+        '''Properties for an AppSync RDS datasource Aurora Serverless V1.
 
         :param api: The API to attach this data source to.
         :param description: the description of the data source. Default: - None
@@ -16941,6 +17135,161 @@ class RdsDataSourceProps(BackedDataSourceProps):
         )
 
 
+@jsii.data_type(
+    jsii_type="aws-cdk-lib.aws_appsync.RdsDataSourcePropsV2",
+    jsii_struct_bases=[BackedDataSourceProps],
+    name_mapping={
+        "api": "api",
+        "description": "description",
+        "name": "name",
+        "service_role": "serviceRole",
+        "secret_store": "secretStore",
+        "serverless_cluster": "serverlessCluster",
+        "database_name": "databaseName",
+    },
+)
+class RdsDataSourcePropsV2(BackedDataSourceProps):
+    def __init__(
+        self,
+        *,
+        api: IGraphqlApi,
+        description: typing.Optional[builtins.str] = None,
+        name: typing.Optional[builtins.str] = None,
+        service_role: typing.Optional[_IRole_235f5d8e] = None,
+        secret_store: _ISecret_6e020e6a,
+        serverless_cluster: _IDatabaseCluster_6554c32b,
+        database_name: typing.Optional[builtins.str] = None,
+    ) -> None:
+        '''Properties for an AppSync RDS datasource Aurora Serverless V2.
+
+        :param api: The API to attach this data source to.
+        :param description: the description of the data source. Default: - None
+        :param name: The name of the data source. Default: - id of data source
+        :param service_role: The IAM service role to be assumed by AppSync to interact with the data source. Default: - Create a new role
+        :param secret_store: The secret containing the credentials for the database.
+        :param serverless_cluster: The serverless cluster to call to interact with this data source.
+        :param database_name: The name of the database to use within the cluster. Default: - None
+
+        :exampleMetadata: fixture=_generated
+
+        Example::
+
+            # The code below shows an example of how to instantiate this type.
+            # The values are placeholders you should change.
+            from aws_cdk import aws_appsync as appsync
+            from aws_cdk import aws_iam as iam
+            from aws_cdk import aws_rds as rds
+            from aws_cdk import aws_secretsmanager as secretsmanager
+            
+            # database_cluster: rds.DatabaseCluster
+            # graphql_api: appsync.GraphqlApi
+            # role: iam.Role
+            # secret: secretsmanager.Secret
+            
+            rds_data_source_props_v2 = appsync.RdsDataSourcePropsV2(
+                api=graphql_api,
+                secret_store=secret,
+                serverless_cluster=database_cluster,
+            
+                # the properties below are optional
+                database_name="databaseName",
+                description="description",
+                name="name",
+                service_role=role
+            )
+        '''
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__2a4c5dd27ab94dcef9db42bba97fd0abc5e49c989bce0ba0ca35793d1db20a70)
+            check_type(argname="argument api", value=api, expected_type=type_hints["api"])
+            check_type(argname="argument description", value=description, expected_type=type_hints["description"])
+            check_type(argname="argument name", value=name, expected_type=type_hints["name"])
+            check_type(argname="argument service_role", value=service_role, expected_type=type_hints["service_role"])
+            check_type(argname="argument secret_store", value=secret_store, expected_type=type_hints["secret_store"])
+            check_type(argname="argument serverless_cluster", value=serverless_cluster, expected_type=type_hints["serverless_cluster"])
+            check_type(argname="argument database_name", value=database_name, expected_type=type_hints["database_name"])
+        self._values: typing.Dict[builtins.str, typing.Any] = {
+            "api": api,
+            "secret_store": secret_store,
+            "serverless_cluster": serverless_cluster,
+        }
+        if description is not None:
+            self._values["description"] = description
+        if name is not None:
+            self._values["name"] = name
+        if service_role is not None:
+            self._values["service_role"] = service_role
+        if database_name is not None:
+            self._values["database_name"] = database_name
+
+    @builtins.property
+    def api(self) -> IGraphqlApi:
+        '''The API to attach this data source to.'''
+        result = self._values.get("api")
+        assert result is not None, "Required property 'api' is missing"
+        return typing.cast(IGraphqlApi, result)
+
+    @builtins.property
+    def description(self) -> typing.Optional[builtins.str]:
+        '''the description of the data source.
+
+        :default: - None
+        '''
+        result = self._values.get("description")
+        return typing.cast(typing.Optional[builtins.str], result)
+
+    @builtins.property
+    def name(self) -> typing.Optional[builtins.str]:
+        '''The name of the data source.
+
+        :default: - id of data source
+        '''
+        result = self._values.get("name")
+        return typing.cast(typing.Optional[builtins.str], result)
+
+    @builtins.property
+    def service_role(self) -> typing.Optional[_IRole_235f5d8e]:
+        '''The IAM service role to be assumed by AppSync to interact with the data source.
+
+        :default: - Create a new role
+        '''
+        result = self._values.get("service_role")
+        return typing.cast(typing.Optional[_IRole_235f5d8e], result)
+
+    @builtins.property
+    def secret_store(self) -> _ISecret_6e020e6a:
+        '''The secret containing the credentials for the database.'''
+        result = self._values.get("secret_store")
+        assert result is not None, "Required property 'secret_store' is missing"
+        return typing.cast(_ISecret_6e020e6a, result)
+
+    @builtins.property
+    def serverless_cluster(self) -> _IDatabaseCluster_6554c32b:
+        '''The serverless cluster to call to interact with this data source.'''
+        result = self._values.get("serverless_cluster")
+        assert result is not None, "Required property 'serverless_cluster' is missing"
+        return typing.cast(_IDatabaseCluster_6554c32b, result)
+
+    @builtins.property
+    def database_name(self) -> typing.Optional[builtins.str]:
+        '''The name of the database to use within the cluster.
+
+        :default: - None
+        '''
+        result = self._values.get("database_name")
+        return typing.cast(typing.Optional[builtins.str], result)
+
+    def __eq__(self, rhs: typing.Any) -> builtins.bool:
+        return isinstance(rhs, self.__class__) and rhs._values == self._values
+
+    def __ne__(self, rhs: typing.Any) -> builtins.bool:
+        return not (rhs == self)
+
+    def __repr__(self) -> str:
+        return "RdsDataSourcePropsV2(%s)" % ", ".join(
+            k + "=" + repr(v) for k, v in self._values.items()
+        )
+
+
 class GraphqlApi(
     GraphqlApiBase,
     metaclass=jsii.JSIIMeta,
@@ -17228,6 +17577,7 @@ __all__ = [
     "PrimaryKey",
     "RdsDataSource",
     "RdsDataSourceProps",
+    "RdsDataSourcePropsV2",
     "Resolver",
     "ResolverProps",
     "RuntimeConfig",
@@ -18822,6 +19172,18 @@ def _typecheckingstub__00411b1875c06ea0450c7cb3f4f4dbd07f2f28986d7180e3a06f5ea23
     """Type checking stubs"""
     pass
 
+def _typecheckingstub__61bc6fb619aeb960346b149372d6f08ad695a7fb87cd5ad9ed2cbcb5146b60f3(
+    id: builtins.str,
+    serverless_cluster: _IDatabaseCluster_6554c32b,
+    secret_store: _ISecret_6e020e6a,
+    database_name: typing.Optional[builtins.str] = None,
+    *,
+    description: typing.Optional[builtins.str] = None,
+    name: typing.Optional[builtins.str] = None,
+) -> None:
+    """Type checking stubs"""
+    pass
+
 def _typecheckingstub__7845da8546318a24ccdcc5b7669f4273b997f01e1807a63aae7beabbe99b178b(
     construct: _CfnResource_9df397a6,
 ) -> None:
@@ -19529,6 +19891,18 @@ def _typecheckingstub__5c5e408fa29227d2c0f12593dd86151b649a2b97300fea604c91973af
     """Type checking stubs"""
     pass
 
+def _typecheckingstub__0d4d8935d69e29b6975caad596c95628af13c6b8e33430de6530665203cf5ef8(
+    id: builtins.str,
+    serverless_cluster: _IDatabaseCluster_6554c32b,
+    secret_store: _ISecret_6e020e6a,
+    database_name: typing.Optional[builtins.str] = None,
+    *,
+    description: typing.Optional[builtins.str] = None,
+    name: typing.Optional[builtins.str] = None,
+) -> None:
+    """Type checking stubs"""
+    pass
+
 def _typecheckingstub__d3519600d64431e6297911193398dcc136af3b4dd3ec5511d0601a8cbf274f4c(
     construct: _CfnResource_9df397a6,
 ) -> None:
@@ -19682,6 +20056,19 @@ def _typecheckingstub__c062ac22fbaef687d5273408a83f4b49e1466d504c5d1d22aa7e464c3
     """Type checking stubs"""
     pass
 
+def _typecheckingstub__2a4c5dd27ab94dcef9db42bba97fd0abc5e49c989bce0ba0ca35793d1db20a70(
+    *,
+    api: IGraphqlApi,
+    description: typing.Optional[builtins.str] = None,
+    name: typing.Optional[builtins.str] = None,
+    service_role: typing.Optional[_IRole_235f5d8e] = None,
+    secret_store: _ISecret_6e020e6a,
+    serverless_cluster: _IDatabaseCluster_6554c32b,
+    database_name: typing.Optional[builtins.str] = None,
+) -> None:
+    """Type checking stubs"""
+    pass
+
 def _typecheckingstub__cdc21261f45618890d843fff7978e6e8e4f4cfe7884c4fffbff6b8dad98036d4(
     scope: _constructs_77d1e7e8.Construct,
     id: builtins.str,