Package software.amazon.awscdk.services.appsync

Interface AuthorizationMode

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
AuthorizationMode.Jsii$Proxy
@Generated(value="jsii-pacmak/1.94.0 (build b380f01)", date="2024-03-14T22:21:50.353Z") @Stability(Stable) public interface AuthorizationMode extends software.amazon.jsii.JsiiSerializable
Interface to specify default or additional authorization(s).

Example: 

 GraphqlApi api = GraphqlApi.Builder.create(this, "Api")
         .name("demo")
         .definition(Definition.fromFile(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.
 // Resolver Mapping Template Reference:
 // https://docs.aws.amazon.com/appsync/latest/devguide/resolver-mapping-template-reference-dynamodb.html
 demoDS.createResolver("QueryGetDemosResolver", 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("MutationAddDemoResolver", BaseResolverProps.builder()
         .typeName("Mutation")
         .fieldName("addDemo")
         .requestMappingTemplate(MappingTemplate.dynamoDbPutItem(PrimaryKey.partition("id").auto(), Values.projecting("input")))
         .responseMappingTemplate(MappingTemplate.dynamoDbResultItem())
         .build());
 //To enable DynamoDB read consistency with the `MappingTemplate`:
 demoDS.createResolver("QueryGetDemosConsistentResolver", BaseResolverProps.builder()
         .typeName("Query")
         .fieldName("getDemosConsistent")
         .requestMappingTemplate(MappingTemplate.dynamoDbScanTable(true))
         .responseMappingTemplate(MappingTemplate.dynamoDbResultList())
         .build());

  • Method Details

    • getAuthorizationType

      @Stability(Stable) @NotNull AuthorizationType getAuthorizationType()
      One of possible four values AppSync supports.

      Default: - `AuthorizationType.API_KEY`

      See Also:

    • getApiKeyConfig

      @Stability(Stable) @Nullable default ApiKeyConfig getApiKeyConfig()
      If authorizationType is AuthorizationType.API_KEY, this option can be configured.

      Default: - name: 'DefaultAPIKey' | description: 'Default API Key created by CDK'

    • getLambdaAuthorizerConfig

      @Stability(Stable) @Nullable default LambdaAuthorizerConfig getLambdaAuthorizerConfig()
      If authorizationType is AuthorizationType.LAMBDA, this option is required.

      Default: - none

    • getOpenIdConnectConfig

      @Stability(Stable) @Nullable default OpenIdConnectConfig getOpenIdConnectConfig()
      If authorizationType is AuthorizationType.OIDC, this option is required.

      Default: - none

    • getUserPoolConfig

      @Stability(Stable) @Nullable default UserPoolConfig getUserPoolConfig()
      If authorizationType is AuthorizationType.USER_POOL, this option is required.

      Default: - none

    • builder

      @Stability(Stable) static AuthorizationMode.Builder builder()
      Returns:
      a AuthorizationMode.Builder of AuthorizationMode