AWS AppSync Construct Library
---
All classes with the
Cfnprefix in this module (CFN Resources) are always stable and safe to use.
The APIs of higher level constructs in this module are experimental and under active development. They are subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model and breaking changes will be announced in the release notes. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.
This module is part of the AWS Cloud Development Kit project.
Usage Example
Given the following GraphQL schema file schema.graphql:
type ServiceVersion {
version: String!
}
type Customer {
id: String!
name: String!
}
input SaveCustomerInput {
name: String!
}
type Order {
customer: String!
order: String!
}
type Query {
getServiceVersion: ServiceVersion
getCustomers: [Customer]
getCustomer(id: String): Customer
}
input FirstOrderInput {
product: String!
quantity: Int!
}
type Mutation {
addCustomer(customer: SaveCustomerInput!): Customer
saveCustomer(id: String!, customer: SaveCustomerInput!): Customer
removeCustomer(id: String!): Customer
saveCustomerWithFirstOrder(customer: SaveCustomerInput!, order: FirstOrderInput!, referral: String): Order
}
the following CDK app snippet will create a complete CRUD AppSync API:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
class ApiStack(Stack):
def __init__(self, scope, id):
super().__init__(scope, id)
user_pool = UserPool(self, "UserPool",
user_pool_name="myPool"
)
api = GraphQLApi(self, "Api",
name="demoapi",
log_config={
"field_log_level": FieldLogLevel.ALL
},
authorization_config={
"default_authorization": {
"user_pool": user_pool,
"default_action": UserPoolDefaultAction.ALLOW
},
"additional_authorization_modes": [{
"api_key_desc": "My API Key"
}
]
},
schema_definition_file="./schema.graphql"
)
none_dS = api.add_none_data_source("None", "Dummy data source")
none_dS.create_resolver(
type_name="Query",
field_name="getServiceVersion",
request_mapping_template=MappingTemplate.from_string(JSON.stringify(
version="2017-02-28"
)),
response_mapping_template=MappingTemplate.from_string(JSON.stringify(
version="v1"
))
)
customer_table = Table(self, "CustomerTable",
billing_mode=BillingMode.PAY_PER_REQUEST,
partition_key={
"name": "id",
"type": AttributeType.STRING
}
)
customer_dS = api.add_dynamo_db_data_source("Customer", "The customer data source", customer_table)
customer_dS.create_resolver(
type_name="Query",
field_name="getCustomers",
request_mapping_template=MappingTemplate.dynamo_db_scan_table(),
response_mapping_template=MappingTemplate.dynamo_db_result_list()
)
customer_dS.create_resolver(
type_name="Query",
field_name="getCustomer",
request_mapping_template=MappingTemplate.dynamo_db_get_item("id", "id"),
response_mapping_template=MappingTemplate.dynamo_db_result_item()
)
customer_dS.create_resolver(
type_name="Mutation",
field_name="addCustomer",
request_mapping_template=MappingTemplate.dynamo_db_put_item(
PrimaryKey.partition("id").auto(),
Values.projecting("customer")),
response_mapping_template=MappingTemplate.dynamo_db_result_item()
)
customer_dS.create_resolver(
type_name="Mutation",
field_name="saveCustomer",
request_mapping_template=MappingTemplate.dynamo_db_put_item(
PrimaryKey.partition("id").is("id"),
Values.projecting("customer")),
response_mapping_template=MappingTemplate.dynamo_db_result_item()
)
customer_dS.create_resolver(
type_name="Mutation",
field_name="saveCustomerWithFirstOrder",
request_mapping_template=MappingTemplate.dynamo_db_put_item(
PrimaryKey.partition("order").auto().sort("customer").is("customer.id"),
Values.projecting("order").attribute("referral").is("referral")),
response_mapping_template=MappingTemplate.dynamo_db_result_item()
)
customer_dS.create_resolver(
type_name="Mutation",
field_name="removeCustomer",
request_mapping_template=MappingTemplate.dynamo_db_delete_item("id", "id"),
response_mapping_template=MappingTemplate.dynamo_db_result_item()
)
2 maintainers
Release files for aws-cdk.aws-appsync 1.41.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| aws-cdk.aws-appsync-1.41.0.tar.gz | 137.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| aws_cdk.aws_appsync-1.41.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size:272.2 kB
Release files / aws-cdk.aws-appsync-1.41.0.tar.gz
| Download URL | aws-cdk.aws-appsync-1.41.0.tar.gz |
|---|---|
| Size | 137.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
96b393a34b99e119fe5977bcecc4922f3373b5a7b5bb51b61491a7366e5049a2
|
|
BLAKE2b-256 checksum How to use checksums |
94f19fbb7b87c87e919a4ecefabbb3c5b2e86daca762f1232623f16888f49a68
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.5
|
Release files / aws_cdk.aws_appsync-1.41.0-py3-none-any.whl
| Download URL | aws_cdk.aws_appsync-1.41.0-py3-none-any.whl |
|---|---|
| Size | 135.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
51bfde03777b6261cb8a4774ef2a187ee64cdedd605a37c7ca2bde53157065b3
|
|
BLAKE2b-256 checksum How to use checksums |
5782fabf67b03f95d12ac006775a1b5db909b3693bea1a0bdc10dea11124ec27
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.5
|
