software.amazon.awssdk.services.apigatewayv2.model

Interface GetAuthorizerResponse.Builder

All Superinterfaces:

ApiGatewayV2Response.Builder, AwsResponse.Builder, Buildable, CopyableBuilder<GetAuthorizerResponse.Builder,GetAuthorizerResponse>, SdkBuilder<GetAuthorizerResponse.Builder,GetAuthorizerResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetAuthorizerResponse

public static interface GetAuthorizerResponse.Builder
extends ApiGatewayV2Response.Builder, SdkPojo, CopyableBuilder<GetAuthorizerResponse.Builder,GetAuthorizerResponse>

Method Summary

Modifier and Type	Method and Description
GetAuthorizerResponse.Builder	authorizerCredentialsArn(String authorizerCredentialsArn) Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
GetAuthorizerResponse.Builder	authorizerId(String authorizerId) The authorizer identifier.
GetAuthorizerResponse.Builder	authorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds) The time to live (TTL), in seconds, of cached authorizer results.
GetAuthorizerResponse.Builder	authorizerType(AuthorizerType authorizerType) The authorizer type.
GetAuthorizerResponse.Builder	authorizerType(String authorizerType) The authorizer type.
GetAuthorizerResponse.Builder	authorizerUri(String authorizerUri) The authorizer's Uniform Resource Identifier (URI).
GetAuthorizerResponse.Builder	identitySource(Collection<String> identitySource) The identity source for which authorization is requested.
GetAuthorizerResponse.Builder	identitySource(String... identitySource) The identity source for which authorization is requested.
GetAuthorizerResponse.Builder	identityValidationExpression(String identityValidationExpression) The validation expression does not apply to the REQUEST authorizer.
GetAuthorizerResponse.Builder	name(String name) The name of the authorizer.
GetAuthorizerResponse.Builder	providerArns(Collection<String> providerArns) For REQUEST authorizer, this is not defined.
GetAuthorizerResponse.Builder	providerArns(String... providerArns) For REQUEST authorizer, this is not defined.

Methods inherited from interface software.amazon.awssdk.services.apigatewayv2.model.ApiGatewayV2Response.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

authorizerCredentialsArn

GetAuthorizerResponse.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, specify null.

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, specify null.

Returns:

Returns a reference to this object so that method calls can be chained together.

authorizerId

GetAuthorizerResponse.Builder authorizerId(String authorizerId)

The authorizer identifier.

Parameters:

authorizerId - The authorizer identifier.

Returns:

Returns a reference to this object so that method calls can be chained together.

authorizerResultTtlInSeconds

GetAuthorizerResponse.Builder authorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds)

The time to live (TTL), in seconds, of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

Parameters:

authorizerResultTtlInSeconds - The time to live (TTL), in seconds, of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

Returns:

Returns a reference to this object so that method calls can be chained together.

authorizerType

GetAuthorizerResponse.Builder authorizerType(String authorizerType)

The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.

Parameters:

authorizerType - The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthorizerType, AuthorizerType

authorizerType

GetAuthorizerResponse.Builder authorizerType(AuthorizerType authorizerType)

The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.

Parameters:

authorizerType - The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthorizerType, AuthorizerType

authorizerUri

GetAuthorizerResponse.Builder authorizerUri(String authorizerUri)

The authorizer's Uniform Resource Identifier (URI). ForREQUEST 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.

Parameters:

authorizerUri - The authorizer's Uniform Resource Identifier (URI). ForREQUEST 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

identitySource

GetAuthorizerResponse.Builder identitySource(Collection<String> identitySource)

The identity source for which authorization is requested.

For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header and a Name query string parameters are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, 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. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

Parameters:

identitySource - The identity source for which authorization is requested.

For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header and a Name query string parameters are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, 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. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

Returns:

Returns a reference to this object so that method calls can be chained together.

identitySource

GetAuthorizerResponse.Builder identitySource(String... identitySource)

The identity source for which authorization is requested.

For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header and a Name query string parameters are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, 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. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

Parameters:

identitySource - The identity source for which authorization is requested.

For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header and a Name query string parameters are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, 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. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

Returns:

Returns a reference to this object so that method calls can be chained together.

identityValidationExpression

GetAuthorizerResponse.Builder identityValidationExpression(String identityValidationExpression)

The validation expression does not apply to the REQUEST authorizer.

Parameters:

identityValidationExpression - The validation expression does not apply to the REQUEST authorizer.

Returns:

Returns a reference to this object so that method calls can be chained together.

name

GetAuthorizerResponse.Builder name(String 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.

providerArns

GetAuthorizerResponse.Builder providerArns(Collection<String> providerArns)

For REQUEST authorizer, this is not defined.

Parameters:

providerArns - For REQUEST authorizer, this is not defined.

Returns:

Returns a reference to this object so that method calls can be chained together.

providerArns

GetAuthorizerResponse.Builder providerArns(String... providerArns)

For REQUEST authorizer, this is not defined.

Parameters:

providerArns - For REQUEST authorizer, this is not defined.

Returns:

Returns a reference to this object so that method calls can be chained together.