software.amazon.awscdk.services.appsync

Class PrimaryKey

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.appsync.PrimaryKey

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

Direct Known Subclasses:

PartitionKey

@Generated(value="jsii-pacmak/1.70.0 (build 03c2f6f)",
           date="2022-11-01T13:16:42.877Z")
 @Stability(value=Experimental)
public class PrimaryKey
extends software.amazon.jsii.JsiiObject

(experimental) Specifies the assignment to the primary key.

It either contains the full primary key or only the partition key.

Example:

 GraphqlApi api = GraphqlApi.Builder.create(this, "Api")
         .name("demo")
         .schema(Schema.fromAsset(join(__dirname, "schema.graphql")))
         .authorizationConfig(AuthorizationConfig.builder()
                 .defaultAuthorization(AuthorizationMode.builder()
                         .authorizationType(AuthorizationType.IAM)
                         .build())
                 .build())
         .xrayEnabled(true)
         .build();
 Table demoTable = Table.Builder.create(this, "DemoTable")
         .partitionKey(Attribute.builder()
                 .name("id")
                 .type(AttributeType.STRING)
                 .build())
         .build();
 DynamoDbDataSource demoDS = api.addDynamoDbDataSource("demoDataSource", demoTable);
 // Resolver for the Query "getDemos" that scans the DynamoDb table and returns the entire list.
 demoDS.createResolver(BaseResolverProps.builder()
         .typeName("Query")
         .fieldName("getDemos")
         .requestMappingTemplate(MappingTemplate.dynamoDbScanTable())
         .responseMappingTemplate(MappingTemplate.dynamoDbResultList())
         .build());
 // Resolver for the Mutation "addDemo" that puts the item into the DynamoDb table.
 demoDS.createResolver(BaseResolverProps.builder()
         .typeName("Mutation")
         .fieldName("addDemo")
         .requestMappingTemplate(MappingTemplate.dynamoDbPutItem(PrimaryKey.partition("id").auto(), Values.projecting("input")))
         .responseMappingTemplate(MappingTemplate.dynamoDbResultItem())
         .build());
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
	PrimaryKey(Assign pkey)
	PrimaryKey(Assign pkey, Assign skey)
protected	PrimaryKey(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	PrimaryKey(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Assign	getPkey()
static PartitionKeyStep	partition(String key) (experimental) Allows assigning a value to the partition key.
String	renderTemplate() (experimental) Renders the key assignment to a VTL string.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

PrimaryKey

protected PrimaryKey(software.amazon.jsii.JsiiObjectRef objRef)

PrimaryKey

protected PrimaryKey(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

PrimaryKey

@Stability(value=Experimental)
public PrimaryKey(@NotNull
                                                 Assign pkey,
                                                 @Nullable
                                                 Assign skey)

Parameters:

pkey - This parameter is required.

skey -

PrimaryKey

@Stability(value=Experimental)
public PrimaryKey(@NotNull
                                                 Assign pkey)

Parameters:

pkey - This parameter is required.

Method Detail

partition

@Stability(value=Experimental)
 @NotNull
public static PartitionKeyStep partition(@NotNull
                                                                                  String key)

(experimental) Allows assigning a value to the partition key.

Parameters:

key - This parameter is required.

renderTemplate

@Stability(value=Experimental)
 @NotNull
public String renderTemplate()

(experimental) Renders the key assignment to a VTL string.

getPkey

@Stability(value=Experimental)
 @NotNull
protected Assign getPkey()