Interface CreateAuthorizerRequest.Builder
- All Superinterfaces:
ApiGatewayV2Request.Builder
,AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateAuthorizerRequest.Builder,
,CreateAuthorizerRequest> SdkBuilder<CreateAuthorizerRequest.Builder,
,CreateAuthorizerRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateAuthorizerRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe API identifier.authorizerCredentialsArn
(String authorizerCredentialsArn) Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.authorizerPayloadFormatVersion
(String authorizerPayloadFormatVersion) Specifies the format of the payload sent to an HTTP API Lambda authorizer.authorizerResultTtlInSeconds
(Integer authorizerResultTtlInSeconds) The time to live (TTL) for cached authorizer results, in seconds.authorizerType
(String authorizerType) The authorizer type.authorizerType
(AuthorizerType authorizerType) The authorizer type.authorizerUri
(String authorizerUri) The authorizer's Uniform Resource Identifier (URI).enableSimpleResponses
(Boolean enableSimpleResponses) Specifies whether a Lambda authorizer returns a response in a simple format.identitySource
(String... identitySource) The identity source for which authorization is requested.identitySource
(Collection<String> identitySource) The identity source for which authorization is requested.identityValidationExpression
(String identityValidationExpression) This parameter is not used.default CreateAuthorizerRequest.Builder
jwtConfiguration
(Consumer<JWTConfiguration.Builder> jwtConfiguration) Represents the configuration of a JWT authorizer.jwtConfiguration
(JWTConfiguration jwtConfiguration) Represents the configuration of a JWT authorizer.The name of the authorizer.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.Methods inherited from interface software.amazon.awssdk.services.apigatewayv2.model.ApiGatewayV2Request.Builder
build
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
apiId
The API identifier.
- Parameters:
apiId
- The API identifier.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
authorizerPayloadFormatVersion
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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).
- Parameters:
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).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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).
- Parameters:
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).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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:
{account_id } :function:{lambda_function_name} /invocations. In general, the URI has this form: arn:aws:apigateway:{region} :lambda:path/{service_api} , where{region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers. - Parameters:
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:{account_id } :function:{lambda_function_name} /invocations. In general, the URI has this form: arn:aws:apigateway:{region} :lambda:path/{service_api} , where{region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers. - Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
- Parameters:
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- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
identityValidationExpression
This parameter is not used.
- Parameters:
identityValidationExpression
- This parameter is not used.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
jwtConfiguration
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
- Parameters:
jwtConfiguration
- Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
jwtConfiguration
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 method that creates an instance of theJWTConfiguration.Builder
avoiding the need to create one manually viaJWTConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tojwtConfiguration(JWTConfiguration)
.- Parameters:
jwtConfiguration
- a consumer that will call methods onJWTConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
name
The name of the authorizer.
- Parameters:
name
- The name of the authorizer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreateAuthorizerRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateAuthorizerRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-