Package software.aws.awsprototypingsdk.openapigateway

Class CognitoAuthorizer

java.lang.Object

software.amazon.jsii.JsiiObject

software.aws.awsprototypingsdk.openapigateway.Authorizer

software.aws.awsprototypingsdk.openapigateway.CognitoAuthorizer

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.61.0 (build abf4039)",
           date="2022-07-07T06:39:53.604Z")
@Stability(Experimental)
public class CognitoAuthorizer
extends Authorizer

(experimental) An authorizer that uses Cognito identity or access tokens.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CognitoAuthorizer.Builder	(experimental) A fluent builder for CognitoAuthorizer.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CognitoAuthorizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CognitoAuthorizer(software.amazon.jsii.JsiiObjectRef objRef)
	CognitoAuthorizer(CognitoAuthorizerProps props)

Method Summary

Modifier and Type	Method	Description
List<String>	getAuthorizationScopes()	(experimental) A list of authorization scopes configured on the method.
List<software.amazon.awscdk.services.cognito.IUserPool>	getUserPools()	(experimental) The Cognito user pools associated with this authorizer.
CognitoAuthorizer	withScopes(@NotNull String... authorizationScopes)	(experimental) Returns this authorizer with scopes applied, intended for usage in individual operations where scopes may differ on a per-operation basis.

Methods inherited from class software.aws.awsprototypingsdk.openapigateway.Authorizer

getAuthorizationType, getAuthorizerId

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

CognitoAuthorizer

protected CognitoAuthorizer(software.amazon.jsii.JsiiObjectRef objRef)

CognitoAuthorizer

protected CognitoAuthorizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CognitoAuthorizer

@Stability(Experimental)
public CognitoAuthorizer(@NotNull
                         CognitoAuthorizerProps props)

Parameters:

props - This parameter is required.

Method Detail

withScopes

@Stability(Experimental)
@NotNull
public CognitoAuthorizer withScopes(@NotNull
                                    @NotNull String... authorizationScopes)

(experimental) Returns this authorizer with scopes applied, intended for usage in individual operations where scopes may differ on a per-operation basis.

Parameters:

authorizationScopes - the scopes to apply. This parameter is required.

See Also:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationscopes

getAuthorizationScopes

@Stability(Experimental)
@NotNull
public List<String> getAuthorizationScopes()

(experimental) A list of authorization scopes configured on the method.

When used as the default authorizer, these scopes will be applied to all methods without an authorizer at the integration level.

See Also:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationscopes

getUserPools

@Stability(Experimental)
@NotNull
public List<software.amazon.awscdk.services.cognito.IUserPool> getUserPools()

(experimental) The Cognito user pools associated with this authorizer.