public static interface CreateAuthorizerRequest.Builder extends ApiGatewayV2Request.Builder, SdkPojo, CopyableBuilder<CreateAuthorizerRequest.Builder,CreateAuthorizerRequest>
Modifier and Type | Method and Description |
---|---|
CreateAuthorizerRequest.Builder |
apiId(String apiId)
The API identifier.
|
CreateAuthorizerRequest.Builder |
authorizerCredentialsArn(String authorizerCredentialsArn)
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
|
CreateAuthorizerRequest.Builder |
authorizerPayloadFormatVersion(String authorizerPayloadFormatVersion)
Specifies the format of the payload sent to an HTTP API Lambda authorizer.
|
CreateAuthorizerRequest.Builder |
authorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds)
The time to live (TTL) for cached authorizer results, in seconds.
|
CreateAuthorizerRequest.Builder |
authorizerType(AuthorizerType authorizerType)
The authorizer type.
|
CreateAuthorizerRequest.Builder |
authorizerType(String authorizerType)
The authorizer type.
|
CreateAuthorizerRequest.Builder |
authorizerUri(String authorizerUri)
The authorizer's Uniform Resource Identifier (URI).
|
CreateAuthorizerRequest.Builder |
enableSimpleResponses(Boolean enableSimpleResponses)
Specifies whether a Lambda authorizer returns a response in a simple format.
|
CreateAuthorizerRequest.Builder |
identitySource(Collection<String> identitySource)
The identity source for which authorization is requested.
|
CreateAuthorizerRequest.Builder |
identitySource(String... identitySource)
The identity source for which authorization is requested.
|
CreateAuthorizerRequest.Builder |
identityValidationExpression(String identityValidationExpression)
This parameter is not used.
|
default CreateAuthorizerRequest.Builder |
jwtConfiguration(Consumer<JWTConfiguration.Builder> jwtConfiguration)
Represents the configuration of a JWT authorizer.
|
CreateAuthorizerRequest.Builder |
jwtConfiguration(JWTConfiguration jwtConfiguration)
Represents the configuration of a JWT authorizer.
|
CreateAuthorizerRequest.Builder |
name(String name)
The name of the authorizer.
|
CreateAuthorizerRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
CreateAuthorizerRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
CreateAuthorizerRequest.Builder apiId(String apiId)
The API identifier.
apiId
- The API identifier.CreateAuthorizerRequest.Builder authorizerCredentialsArn(String authorizerCredentialsArn)
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.
authorizerCredentialsArn
- Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify
an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use
resource-based permissions on the Lambda function, don't specify this parameter. Supported only for
REQUEST authorizers.CreateAuthorizerRequest.Builder authorizerPayloadFormatVersion(String authorizerPayloadFormatVersion)
Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
authorizerPayloadFormatVersion
- Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API
Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.CreateAuthorizerRequest.Builder authorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds)
The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.
authorizerResultTtlInSeconds
- The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization
caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum
value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.CreateAuthorizerRequest.Builder authorizerType(String authorizerType)
The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
authorizerType
- The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify
JWT to use JSON Web Tokens (supported only for HTTP APIs).AuthorizerType
,
AuthorizerType
CreateAuthorizerRequest.Builder authorizerType(AuthorizerType authorizerType)
The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
authorizerType
- The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify
JWT to use JSON Web Tokens (supported only for HTTP APIs).AuthorizerType
,
AuthorizerType
CreateAuthorizerRequest.Builder authorizerUri(String authorizerUri)
The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed
Lambda function URI, for example,
arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda
:us-west-2:
authorizerUri
- The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a
well-formed Lambda function URI, for example,
arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions
/arn:aws:lambda:us-west-2:CreateAuthorizerRequest.Builder enableSimpleResponses(Boolean enableSimpleResponses)
Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs
enableSimpleResponses
- Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda
authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value
instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIsCreateAuthorizerRequest.Builder identitySource(Collection<String> identitySource)
The identity source for which authorization is requested.
For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.
identitySource
- The identity source for which authorization is requested.
For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.
CreateAuthorizerRequest.Builder identitySource(String... identitySource)
The identity source for which authorization is requested.
For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.
identitySource
- The identity source for which authorization is requested.
For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.
CreateAuthorizerRequest.Builder identityValidationExpression(String identityValidationExpression)
This parameter is not used.
identityValidationExpression
- This parameter is not used.CreateAuthorizerRequest.Builder jwtConfiguration(JWTConfiguration jwtConfiguration)
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
jwtConfiguration
- Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only
for HTTP APIs.default CreateAuthorizerRequest.Builder jwtConfiguration(Consumer<JWTConfiguration.Builder> jwtConfiguration)
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
This is a convenience that creates an instance of theJWTConfiguration.Builder
avoiding the need to
create one manually via JWTConfiguration.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to jwtConfiguration(JWTConfiguration)
.jwtConfiguration
- a consumer that will call methods on JWTConfiguration.Builder
jwtConfiguration(JWTConfiguration)
CreateAuthorizerRequest.Builder name(String name)
The name of the authorizer.
name
- The name of the authorizer.CreateAuthorizerRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.CreateAuthorizerRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.