Package software.aws.awsprototypingsdk.openapigateway

Interface CognitoAuthorizerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CognitoAuthorizerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.80.0 (build bce6a1d)",
           date="2023-05-30T03:49:55.455Z")
@Stability(Experimental)
public interface CognitoAuthorizerProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties used to configure a cognito authorizer.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CognitoAuthorizerProps.Builder	builder()
default List<String>	getAuthorizationScopes()	(experimental) A list of authorization scopes configured on the method.
String	getAuthorizerId()	(experimental) Unique identifier for this authorizer.
List<software.amazon.awscdk.services.cognito.IUserPool>	getUserPools()	(experimental) The Cognito user pools associated with this authorizer.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAuthorizerId

@Stability(Experimental)
@NotNull
String getAuthorizerId()

(experimental) Unique identifier for this authorizer.

getUserPools

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

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

getAuthorizationScopes

@Stability(Experimental)
@Nullable
default 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.

Default: []

See Also:

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

builder

@Stability(Experimental)
static CognitoAuthorizerProps.Builder builder()

Returns:

a CognitoAuthorizerProps.Builder of CognitoAuthorizerProps