Package software.aws.awsprototypingsdk.openapigateway

Class CognitoAuthorizer.Builder

java.lang.Object

software.aws.awsprototypingsdk.openapigateway.CognitoAuthorizer.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CognitoAuthorizer>

Enclosing class:

CognitoAuthorizer

@Stability(Experimental)
public static final class CognitoAuthorizer.Builder
extends Object
implements software.amazon.jsii.Builder<CognitoAuthorizer>

(experimental) A fluent builder for CognitoAuthorizer.

Method Summary

Modifier and Type	Method	Description
CognitoAuthorizer.Builder	authorizationScopes(List<String> authorizationScopes)	(experimental) A list of authorization scopes configured on the method.
CognitoAuthorizer.Builder	authorizerId(String authorizerId)	(experimental) Unique identifier for this authorizer.
CognitoAuthorizer	build()
static CognitoAuthorizer.Builder	create()
CognitoAuthorizer.Builder	userPools(List<? extends software.amazon.awscdk.services.cognito.IUserPool> userPools)	(experimental) The Cognito user pools associated with this authorizer.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(Experimental)
public static CognitoAuthorizer.Builder create()

Returns:

a new instance of CognitoAuthorizer.Builder.

authorizerId

@Stability(Experimental)
public CognitoAuthorizer.Builder authorizerId(String authorizerId)

(experimental) Unique identifier for this authorizer.

Parameters:

authorizerId - Unique identifier for this authorizer. This parameter is required.

Returns:

this

userPools

@Stability(Experimental)
public CognitoAuthorizer.Builder userPools(List<? extends software.amazon.awscdk.services.cognito.IUserPool> userPools)

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

Parameters:

userPools - The Cognito user pools associated with this authorizer. This parameter is required.

Returns:

this

authorizationScopes

@Stability(Experimental)
public CognitoAuthorizer.Builder authorizationScopes(List<String> authorizationScopes)

(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: []

Parameters:

authorizationScopes - A list of authorization scopes configured on the method. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Experimental)
public CognitoAuthorizer build()

Specified by:

build in interface software.amazon.jsii.Builder<CognitoAuthorizer>