Skip to content
v2.277.0

MappingTemplate Class ​

MappingTemplates for AppSync resolvers.

Example ​

ts
// Create username and password secret for DB Cluster
const secret = new rds.DatabaseSecret(this, 'AuroraSecret', {
  username: 'clusteradmin',
});

// The VPC to place the cluster in
const vpc = new ec2.Vpc(this, 'AuroraVpc');

// Create the serverless cluster, provide all values needed to customise the database.
const cluster = new rds.ServerlessCluster(this, 'AuroraCluster', {
  engine: rds.DatabaseClusterEngine.AURORA_MYSQL,
  vpc,
  credentials: { username: 'clusteradmin' },
  clusterIdentifier: 'db-endpoint-test',
  defaultDatabaseName: 'demos',
});

// Build a data source for AppSync to access the database.
declare const api: appsync.GraphqlApi;
const rdsDS = api.addRdsDataSource('rds', cluster, secret, 'demos');

// Set up a resolver for an RDS query.
rdsDS.createResolver('QueryGetDemosRdsResolver', {
  typeName: 'Query',
  fieldName: 'getDemosRds',
  requestMappingTemplate: appsync.MappingTemplate.fromString(`
  {
    "version": "2018-05-29",
    "statements": [
      "SELECT * FROM demos"
    ]
  }
  `),
  responseMappingTemplate: appsync.MappingTemplate.fromString(`
    $utils.toJson($utils.rds.toJsonObject($ctx.result)[0])
  `),
});

// Set up a resolver for an RDS mutation.
rdsDS.createResolver('MutationAddDemoRdsResolver', {
  typeName: 'Mutation',
  fieldName: 'addDemoRds',
  requestMappingTemplate: appsync.MappingTemplate.fromString(`
  {
    "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)
    }
  }
  `),
  responseMappingTemplate: appsync.MappingTemplate.fromString(`
    $utils.toJson($utils.rds.toJsonObject($ctx.result)[1][0])
  `),
});
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.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")

# 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])
          """)
)
java
// Build a data source for AppSync to access the database.
GraphqlApi api;
// Create username and password secret for DB Cluster
DatabaseSecret secret = DatabaseSecret.Builder.create(this, "AuroraSecret")
        .username("clusteradmin")
        .build();

// The VPC to place the cluster in
Vpc vpc = new Vpc(this, "AuroraVpc");

// Create the serverless cluster, provide all values needed to customise the database.
ServerlessCluster cluster = ServerlessCluster.Builder.create(this, "AuroraCluster")
        .engine(DatabaseClusterEngine.AURORA_MYSQL)
        .vpc(vpc)
        .credentials(Map.of("username", "clusteradmin"))
        .clusterIdentifier("db-endpoint-test")
        .defaultDatabaseName("demos")
        .build();
RdsDataSource rdsDS = api.addRdsDataSource("rds", cluster, secret, "demos");

// Set up a resolver for an RDS query.
rdsDS.createResolver("QueryGetDemosRdsResolver", BaseResolverProps.builder()
        .typeName("Query")
        .fieldName("getDemosRds")
        .requestMappingTemplate(MappingTemplate.fromString("\n  {\n    \"version\": \"2018-05-29\",\n    \"statements\": [\n      \"SELECT * FROM demos\"\n    ]\n  }\n  "))
        .responseMappingTemplate(MappingTemplate.fromString("\n    $utils.toJson($utils.rds.toJsonObject($ctx.result)[0])\n  "))
        .build());

// Set up a resolver for an RDS mutation.
rdsDS.createResolver("MutationAddDemoRdsResolver", BaseResolverProps.builder()
        .typeName("Mutation")
        .fieldName("addDemoRds")
        .requestMappingTemplate(MappingTemplate.fromString("\n  {\n    \"version\": \"2018-05-29\",\n    \"statements\": [\n      \"INSERT INTO demos VALUES (:id, :version)\",\n      \"SELECT * WHERE id = :id\"\n    ],\n    \"variableMap\": {\n      \":id\": $util.toJson($util.autoId()),\n      \":version\": $util.toJson($ctx.args.version)\n    }\n  }\n  "))
        .responseMappingTemplate(MappingTemplate.fromString("\n    $utils.toJson($utils.rds.toJsonObject($ctx.result)[1][0])\n  "))
        .build());
csharp
// Install: dotnet add package Amazon.CDK.Lib
// Build a data source for AppSync to access the database.
GraphqlApi api;
// Create username and password secret for DB Cluster
var secret = new DatabaseSecret(this, "AuroraSecret", new DatabaseSecretProps {
    Username = "clusteradmin"
});

// The VPC to place the cluster in
var vpc = new Vpc(this, "AuroraVpc");

// Create the serverless cluster, provide all values needed to customise the database.
var cluster = new ServerlessCluster(this, "AuroraCluster", new ServerlessClusterProps {
    Engine = DatabaseClusterEngine.AURORA_MYSQL,
    Vpc = vpc,
    Credentials = new Dictionary<string, string> { { "username", "clusteradmin" } },
    ClusterIdentifier = "db-endpoint-test",
    DefaultDatabaseName = "demos"
});
var rdsDS = api.AddRdsDataSource("rds", cluster, secret, "demos");

// Set up a resolver for an RDS query.
rdsDS.CreateResolver("QueryGetDemosRdsResolver", new BaseResolverProps {
    TypeName = "Query",
    FieldName = "getDemosRds",
    RequestMappingTemplate = MappingTemplate.FromString(@"
      {
        ""version"": ""2018-05-29"",
        ""statements"": [
          ""SELECT * FROM demos""
        ]
      }
      "),
    ResponseMappingTemplate = MappingTemplate.FromString(@"
        $utils.toJson($utils.rds.toJsonObject($ctx.result)[0])
      ")
});

// Set up a resolver for an RDS mutation.
rdsDS.CreateResolver("MutationAddDemoRdsResolver", new BaseResolverProps {
    TypeName = "Mutation",
    FieldName = "addDemoRds",
    RequestMappingTemplate = MappingTemplate.FromString(@"
      {
        ""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)
        }
      }
      "),
    ResponseMappingTemplate = MappingTemplate.FromString(@"
        $utils.toJson($utils.rds.toJsonObject($ctx.result)[1][0])
      ")
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// Build a data source for AppSync to access the database.
var api GraphqlApi
// Create username and password secret for DB Cluster
secret := rds.NewDatabaseSecret(this, jsii.String("AuroraSecret"), &DatabaseSecretProps{
	Username: jsii.String("clusteradmin"),
})

// The VPC to place the cluster in
vpc := ec2.NewVpc(this, jsii.String("AuroraVpc"))

// Create the serverless cluster, provide all values needed to customise the database.
cluster := rds.NewServerlessCluster(this, jsii.String("AuroraCluster"), &ServerlessClusterProps{
	Engine: rds.DatabaseClusterEngine_AURORA_MYSQL(),
	Vpc: Vpc,
	Credentials: map[string]*string{
		"username": jsii.String("clusteradmin"),
	},
	ClusterIdentifier: jsii.String("db-endpoint-test"),
	DefaultDatabaseName: jsii.String("demos"),
})
rdsDS := api.AddRdsDataSource(jsii.String("rds"), cluster, secret, jsii.String("demos"))

// Set up a resolver for an RDS query.
rdsDS.CreateResolver(jsii.String("QueryGetDemosRdsResolver"), &BaseResolverProps{
	TypeName: jsii.String("Query"),
	FieldName: jsii.String("getDemosRds"),
	RequestMappingTemplate: appsync.MappingTemplate_FromString(jsii.String(`
	  {
	    "version": "2018-05-29",
	    "statements": [
	      "SELECT * FROM demos"
	    ]
	  }
	  `)),
	ResponseMappingTemplate: appsync.MappingTemplate_*FromString(jsii.String(`
	    $utils.toJson($utils.rds.toJsonObject($ctx.result)[0])
	  `)),
})

// Set up a resolver for an RDS mutation.
rdsDS.CreateResolver(jsii.String("MutationAddDemoRdsResolver"), &BaseResolverProps{
	TypeName: jsii.String("Mutation"),
	FieldName: jsii.String("addDemoRds"),
	RequestMappingTemplate: appsync.MappingTemplate_*FromString(jsii.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)
	    }
	  }
	  `)),
	ResponseMappingTemplate: appsync.MappingTemplate_*FromString(jsii.String(`
	    $utils.toJson($utils.rds.toJsonObject($ctx.result)[1][0])
	  `)),
})

Initializer ​

ts
new MappingTemplate()
python
MappingTemplate()
java
new MappingTemplate()
csharp
new MappingTemplate()
go
NewMappingTemplate()

Methods ​

dynamoDbDeleteItem(keyName: string, idArg: string): MappingTemplate // chainable@staticmethod def dynamo_db_delete_item(key_name: str, id_arg: str) -> MappingTemplatepublic static MappingTemplate dynamoDbDeleteItem(String keyName, String idArg)public static MappingTemplate DynamoDbDeleteItem(string keyName, string idArg)func DynamoDbDeleteItem(KeyName *string, IdArg *string) MappingTemplatestatic#
Mapping template to delete a single item from a DynamoDB table.
2 parameters

Parameters

  • keyNamekey_namekeyNamekeyNameKeyName — the name of the hash key field.
  • idArgid_argidArgidArgIdArg — the name of the Mutation argument.
dynamoDbGetItem(keyName: string, idArg: string, consistentRead?: boolean): MappingTemplate // chainable@staticmethod def dynamo_db_get_item(key_name: str, id_arg: str, consistent_read: typing.Optional[bool] = None) -> MappingTemplatepublic static MappingTemplate dynamoDbGetItem(String keyName, String idArg, Boolean consistentRead)public static MappingTemplate DynamoDbGetItem(string keyName, string idArg, bool? consistentRead = null)func DynamoDbGetItem(KeyName *string, IdArg *string, ConsistentRead *bool) MappingTemplatestatic#
Mapping template to get a single item from a DynamoDB table.
2 parameters

Parameters

  • keyNamekey_namekeyNamekeyNameKeyName — the name of the hash key field.
  • idArgid_argidArgidArgIdArg — the name of the Query argument.
dynamoDbPutItem(key: PrimaryKey, values: AttributeValues): MappingTemplate // chainable@staticmethod def dynamo_db_put_item(key: PrimaryKey, values: AttributeValues) -> MappingTemplatepublic static MappingTemplate dynamoDbPutItem(PrimaryKey key, AttributeValues values)public static MappingTemplate DynamoDbPutItem(PrimaryKey key, AttributeValues values)func DynamoDbPutItem(Key PrimaryKey, Values AttributeValues) MappingTemplatestatic#
Mapping template to save a single item to a DynamoDB table.
2 parameters

Parameters

  • keykeykeykeyKey — the assigment of Mutation values to the primary key.
  • valuesvaluesvaluesvaluesValues — the assignment of Mutation values to the table attributes.
dynamoDbQuery(cond: KeyCondition, indexName?: string, consistentRead?: boolean): MappingTemplate // chainable@staticmethod def dynamo_db_query(cond: KeyCondition, index_name: typing.Optional[str] = None, consistent_read: typing.Optional[bool] = None) -> MappingTemplatepublic static MappingTemplate dynamoDbQuery(KeyCondition cond, String indexName, Boolean consistentRead)public static MappingTemplate DynamoDbQuery(KeyCondition cond, string? indexName = null, bool? consistentRead = null)func DynamoDbQuery(Cond KeyCondition, IndexName *string, ConsistentRead *bool) MappingTemplatestatic#
Mapping template to query a set of items from a DynamoDB table.
1 parameter

Parameters

  • condcondcondcondCond — the key condition for the query.
dynamoDbResultItem(): MappingTemplate // chainable@staticmethod def dynamo_db_result_item() -> MappingTemplatepublic static MappingTemplate dynamoDbResultItem()public static MappingTemplate DynamoDbResultItem()func DynamoDbResultItem() MappingTemplatestatic#
Mapping template for a single result item from DynamoDB.
dynamoDbResultList(): MappingTemplate // chainable@staticmethod def dynamo_db_result_list() -> MappingTemplatepublic static MappingTemplate dynamoDbResultList()public static MappingTemplate DynamoDbResultList()func DynamoDbResultList() MappingTemplatestatic#
Mapping template for a result list from DynamoDB.
dynamoDbScanTable(consistentRead?: boolean): MappingTemplate // chainable@staticmethod def dynamo_db_scan_table(consistent_read: typing.Optional[bool] = None) -> MappingTemplatepublic static MappingTemplate dynamoDbScanTable(Boolean consistentRead)public static MappingTemplate DynamoDbScanTable(bool? consistentRead = null)func DynamoDbScanTable(ConsistentRead *bool) MappingTemplatestatic#
Mapping template to scan a DynamoDB table to fetch all entries.
fromFile(fileName: string): MappingTemplate // chainable@staticmethod def from_file(file_name: str) -> MappingTemplatepublic static MappingTemplate fromFile(String fileName)public static MappingTemplate FromFile(string fileName)func FromFile(FileName *string) MappingTemplatestatic#
Create a mapping template from the given file.
fromString(template: string): MappingTemplate // chainable@staticmethod def from_string(template: str) -> MappingTemplatepublic static MappingTemplate fromString(String template)public static MappingTemplate FromString(string template)func FromString(Template *string) MappingTemplatestatic#
Create a mapping template from the given string.
lambdaRequest(payload?: string, operation?: string): MappingTemplate // chainable@staticmethod def lambda_request(payload: typing.Optional[str] = None, operation: typing.Optional[str] = None) -> MappingTemplatepublic static MappingTemplate lambdaRequest(String payload, String operation)public static MappingTemplate LambdaRequest(string? payload = null, string? operation = null)func LambdaRequest(Payload *string, Operation *string) MappingTemplatestatic#
Mapping template to invoke a Lambda function.
2 parameters

Parameters

  • payloadpayloadpayloadpayloadPayload — the VTL template snippet of the payload to send to the lambda.
  • operationoperationoperationoperationOperation — the type of operation AppSync should perform on the data source.
lambdaResult(): MappingTemplate // chainable@staticmethod def lambda_result() -> MappingTemplatepublic static MappingTemplate lambdaResult()public static MappingTemplate LambdaResult()func LambdaResult() MappingTemplatestatic#
Mapping template to return the Lambda result to the caller.
renderTemplate(): stringdef render_template(self, ) -> strpublic String renderTemplate()public string RenderTemplate()func RenderTemplate() *string#
this is called to render the mapping template to a VTL string.