Class CustomAuthorizer.Builder
- java.lang.Object
-
- software.aws.awsprototypingsdk.openapigateway.CustomAuthorizer.Builder
-
- All Implemented Interfaces:
software.amazon.jsii.Builder<CustomAuthorizer>
- Enclosing class:
- CustomAuthorizer
@Stability(Experimental) public static final class CustomAuthorizer.Builder extends Object implements software.amazon.jsii.Builder<CustomAuthorizer>
(experimental) A fluent builder forCustomAuthorizer.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description CustomAuthorizer.BuilderauthorizerId(String authorizerId)(experimental) Unique identifier for this authorizer.CustomAuthorizer.BuilderauthorizerResultTtlInSeconds(Number authorizerResultTtlInSeconds)(experimental) The number of seconds during which the authorizer result is cached.CustomAuthorizerbuild()static CustomAuthorizer.Buildercreate()CustomAuthorizer.Builderfunction(software.amazon.awscdk.services.lambda.IFunction function)(experimental) The lambda function used to authorize requests.CustomAuthorizer.BuilderidentitySource(String identitySource)(experimental) The source of the identity in an incoming request.CustomAuthorizer.Buildertype(CustomAuthorizerType type)(experimental) The type of custom authorizer.
-
-
-
Method Detail
-
create
@Stability(Experimental) public static CustomAuthorizer.Builder create()
- Returns:
- a new instance of
CustomAuthorizer.Builder.
-
authorizerId
@Stability(Experimental) public CustomAuthorizer.Builder authorizerId(String authorizerId)
(experimental) Unique identifier for this authorizer.- Parameters:
authorizerId- Unique identifier for this authorizer. This parameter is required.- Returns:
this
-
function
@Stability(Experimental) public CustomAuthorizer.Builder function(software.amazon.awscdk.services.lambda.IFunction function)
(experimental) The lambda function used to authorize requests.- Parameters:
function- The lambda function used to authorize requests. This parameter is required.- Returns:
this
-
authorizerResultTtlInSeconds
@Stability(Experimental) public CustomAuthorizer.Builder authorizerResultTtlInSeconds(Number authorizerResultTtlInSeconds)
(experimental) The number of seconds during which the authorizer result is cached.Default: 300
- Parameters:
authorizerResultTtlInSeconds- The number of seconds during which the authorizer result is cached. This parameter is required.- Returns:
this
-
identitySource
@Stability(Experimental) public CustomAuthorizer.Builder identitySource(String identitySource)
(experimental) The source of the identity in an incoming request.Default: "method.request.header.Authorization"
- Parameters:
identitySource- The source of the identity in an incoming request. This parameter is required.- Returns:
this- See Also:
- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identitysource
-
type
@Stability(Experimental) public CustomAuthorizer.Builder type(CustomAuthorizerType type)
(experimental) The type of custom authorizer.Default: CustomAuthorizerType.TOKEN
- Parameters:
type- The type of custom authorizer. This parameter is required.- Returns:
this- See Also:
- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-type
-
build
@Stability(Experimental) public CustomAuthorizer build()
- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CustomAuthorizer>
-
-