software.amazon.awscdk.services.appsync

Interface AuthorizationConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AuthorizationConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-07T23:47:00.937Z")
 @Stability(value=Experimental)
public interface AuthorizationConfig
extends software.amazon.jsii.JsiiSerializable

(experimental) Configuration of the API authorization modes.

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

Modifier and Type	Interface and Description
static class	AuthorizationConfig.Builder A builder for AuthorizationConfig
static class	AuthorizationConfig.Jsii$Proxy An implementation for AuthorizationConfig

Method Summary

Modifier and Type	Method and Description
static AuthorizationConfig.Builder	builder()
default List<AuthorizationMode>	getAdditionalAuthorizationModes() (experimental) Additional authorization modes.
default AuthorizationMode	getDefaultAuthorization() (experimental) Optional authorization configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAdditionalAuthorizationModes

@Stability(value=Experimental)
 @Nullable
default List<AuthorizationMode> getAdditionalAuthorizationModes()

(experimental) Additional authorization modes.

Default: - No other modes

getDefaultAuthorization

@Stability(value=Experimental)
 @Nullable
default AuthorizationMode getDefaultAuthorization()

(experimental) Optional authorization configuration.

Default: - API Key authorization

builder

@Stability(value=Experimental)
static AuthorizationConfig.Builder builder()

Returns:

a AuthorizationConfig.Builder of AuthorizationConfig