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.70.0 (build 03c2f6f)",
           date="2022-11-01T13:16:42.725Z")
 @Stability(value=Experimental)
public interface AuthorizationMode
extends software.amazon.jsii.JsiiSerializable

(experimental) Interface to specify default or additional authorization(s).

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	AuthorizationMode.Builder A builder for AuthorizationMode
static class	AuthorizationMode.Jsii$Proxy An implementation for AuthorizationMode

Method Summary

Modifier and Type	Method and Description
static AuthorizationMode.Builder	builder()
default ApiKeyConfig	getApiKeyConfig() (experimental) If authorizationType is `AuthorizationType.API_KEY`, this option can be configured.
AuthorizationType	getAuthorizationType() (experimental) One of possible four values AppSync supports.
default LambdaAuthorizerConfig	getLambdaAuthorizerConfig() (experimental) If authorizationType is `AuthorizationType.LAMBDA`, this option is required.
default OpenIdConnectConfig	getOpenIdConnectConfig() (experimental) If authorizationType is `AuthorizationType.OIDC`, this option is required.
default UserPoolConfig	getUserPoolConfig() (experimental) If authorizationType is `AuthorizationType.USER_POOL`, this option is required.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAuthorizationType

@Stability(value=Experimental)
 @NotNull
AuthorizationType getAuthorizationType()

(experimental) One of possible four values AppSync supports.

Default: - `AuthorizationType.API_KEY`

See Also:

https://docs.aws.amazon.com/appsync/latest/devguide/security.html

getApiKeyConfig

@Stability(value=Experimental)
 @Nullable
default ApiKeyConfig getApiKeyConfig()

(experimental) If authorizationType is `AuthorizationType.API_KEY`, this option can be configured.

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

getLambdaAuthorizerConfig

@Stability(value=Experimental)
 @Nullable
default LambdaAuthorizerConfig getLambdaAuthorizerConfig()

(experimental) If authorizationType is `AuthorizationType.LAMBDA`, this option is required.

Default: - none

getOpenIdConnectConfig

@Stability(value=Experimental)
 @Nullable
default OpenIdConnectConfig getOpenIdConnectConfig()

(experimental) If authorizationType is `AuthorizationType.OIDC`, this option is required.

Default: - none

getUserPoolConfig

@Stability(value=Experimental)
 @Nullable
default UserPoolConfig getUserPoolConfig()

(experimental) If authorizationType is `AuthorizationType.USER_POOL`, this option is required.

Default: - none

builder

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

Returns:

a AuthorizationMode.Builder of AuthorizationMode