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
doPostOnAws: String!
}
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": {
"authorization_type": AuthorizationType.USER_POOL,
"user_pool_config": {
"user_pool": user_pool,
"default_action": UserPoolDefaultAction.ALLOW
}
},
"additional_authorization_modes": [{
"authorization_type": AuthorizationType.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
}
)
# If your table is already created you can also use use import table and use it as data source.
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()
)
http_dS = api.add_http_data_source("http", "The http data source", "https://aws.amazon.com/")
http_dS.create_resolver(
type_name="Mutation",
field_name="doPostOnAws",
request_mapping_template=MappingTemplate.from_string("{\n \"version\": \"2018-05-29\",\n \"method\": \"POST\",\n # if full path is https://api.xxxxxxxxx.com/posts then resourcePath would be /posts\n \"resourcePath\": \"/path/123\",\n \"params\":{\n \"body\": $util.toJson($ctx.args),\n \"headers\":{\n \"Content-Type\": \"application/json\",\n \"Authorization\": \"$ctx.request.headers.Authorization\"\n }\n }\n }"),
response_mapping_template=MappingTemplate.from_string("\n ## Raise a GraphQL field error in case of a datasource invocation error\n #if($ctx.error)\n $util.error($ctx.error.message, $ctx.error.type)\n #end\n ## if the response status code is not 200, then return an error. Else return the body **\n #if($ctx.result.statusCode == 200)\n ## If response is 200, return the body.\n $ctx.result.body\n #else\n ## If response is not 200, append the response to error block.\n $utils.appendError($ctx.result.body, \"$ctx.result.statusCode\")\n #end\n ")
)
Metadata
Release files for aws-cdk.aws-appsync 1.51.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 | Provenance | Actions |
|---|---|---|---|---|
| aws-cdk.aws-appsync-1.51.0.tar.gz | 157.2 kB | Without provenance | Details for aws-cdk.aws-appsync-1.51.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| aws_cdk.aws_appsync-1.51.0-py3-none-any.whl | Python 3 | none | any | Details for aws_cdk.aws_appsync-1.51.0-py3-none-any.whl |
Total release size: 313.0 kB
Release files / aws-cdk.aws-appsync-1.51.0.tar.gz
| Download URL | aws-cdk.aws-appsync-1.51.0.tar.gz |
|---|---|
| Size | 157.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
dc63e9525bb3f6223b034bc06daf605c3d8c1dd6fda8a2995b2badb8a23498cc
|
|
BLAKE2b-256 checksum How to use checksums |
f2072147f9f5f19cdb904b7ccdbb0eac4358edbf001cccbf2d48e2410137a737
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.6.5
|
Release files / aws_cdk.aws_appsync-1.51.0-py3-none-any.whl
| Download URL | aws_cdk.aws_appsync-1.51.0-py3-none-any.whl |
|---|---|
| Size | 155.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e8a48b0655e40c409a6685065bffc811ae4a5e00b6b8aa28356365171e53fac3
|
|
BLAKE2b-256 checksum How to use checksums |
6d003d69830fae774f34ee9bf735db061f2a096945e8ef67f6df16c95c84f173
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.6.5
|
Security for aws-cdk.aws-appsync 1.51.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.