software.amazon.awscdk.services.apigateway

Enum AuthorizationType

java.lang.Object

java.lang.Enum<AuthorizationType>

software.amazon.awscdk.services.apigateway.AuthorizationType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AuthorizationType>

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:47.430Z")
public enum AuthorizationType
extends java.lang.Enum<AuthorizationType>

Example:

 Resource books;
 UserPool userPool = new UserPool(this, "UserPool");
 CognitoUserPoolsAuthorizer auth = CognitoUserPoolsAuthorizer.Builder.create(this, "booksAuthorizer")
         .cognitoUserPools(List.of(userPool))
         .build();
 books.addMethod("GET", new HttpIntegration("http://amazon.com"), MethodOptions.builder()
         .authorizer(auth)
         .authorizationType(AuthorizationType.COGNITO)
         .build());
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
COGNITO Use an AWS Cognito user pool.
CUSTOM Use a custom authorizer.
IAM Use AWS IAM permissions.
NONE Open access.

Method Summary

Modifier and Type	Method and Description
static AuthorizationType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AuthorizationType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final AuthorizationType NONE

Open access.

IAM

public static final AuthorizationType IAM

Use AWS IAM permissions.

CUSTOM

public static final AuthorizationType CUSTOM

Use a custom authorizer.

COGNITO

public static final AuthorizationType COGNITO

Use an AWS Cognito user pool.

Method Detail

values

public static AuthorizationType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AuthorizationType c : AuthorizationType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AuthorizationType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null