APIAuthorizationType<T extends AmplifyAuthProvider> enum

The types of authorization one can use while talking to an Amazon AppSync GraphQL backend, or an Amazon API Gateway endpoint.

See also:

• AppSync Security

Inheritance

• Object
• Enum
• APIAuthorizationType

Annotations

• @JsonEnum(alwaysCreate: true)

Constructors

APIAuthorizationType(AmplifyAuthProviderToken<T> authProviderToken)

const

Values

none → const APIAuthorizationType<AmplifyAuthProvider>

For public APIs.

const APIAuthorizationType(AmplifyAuthProviderToken<AmplifyAuthProvider>('NONE'))

apiKey → const APIAuthorizationType<ApiKeyAmplifyAuthProvider>

A hardcoded key which can provide throttling for an unauthenticated API.

See also:

• API Key Authorization

const APIAuthorizationType(AmplifyAuthProviderToken<ApiKeyAmplifyAuthProvider>('API_KEY'))

iam → const APIAuthorizationType<AWSIamAmplifyAuthProvider>

Use an IAM access/secret key credential pair to authorize access to an API.

See also:

• IAM Authorization
• IAM Introduction

const APIAuthorizationType(AmplifyAuthProviderToken<AWSIamAmplifyAuthProvider>('AWS_IAM'))

oidc → const APIAuthorizationType<TokenAmplifyAuthProvider>

OpenID Connect is a simple identity layer on top of OAuth2.0.

See also:

• OpenID Connect Authorization
• OpenID Connect Specification

const APIAuthorizationType(AmplifyAuthProviderToken<TokenAmplifyAuthProvider>('OPENID_CONNECT'))

userPools → const APIAuthorizationType<TokenIdentityAmplifyAuthProvider>

Control access to date by putting users into different permissions pools.

See also:

• Amazon Cognito User Pools

const APIAuthorizationType(AmplifyAuthProviderToken<TokenIdentityAmplifyAuthProvider>('AMAZON_COGNITO_USER_POOLS'))

function → const APIAuthorizationType<TokenAmplifyAuthProvider>

Control access by calling a lambda function.

See also:

• Introducing Lambda authorization for AWS AppSync GraphQL APIs

const APIAuthorizationType(AmplifyAuthProviderToken<TokenAmplifyAuthProvider>('AWS_LAMBDA'))

Properties

authProviderToken → AmplifyAuthProviderToken<T>

final

hashCode → int

The hash code for this object.

no setter, inherited

index → int

A numeric identifier for the enumerated value.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

values → const List<APIAuthorizationType<AmplifyAuthProvider>>

A constant List of the values in this enum, in order of their declaration.