software.amazon.awssdk.services.apigatewayv2.model

Class GetAuthorizerResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.apigatewayv2.model.ApiGatewayV2Response

software.amazon.awssdk.services.apigatewayv2.model.GetAuthorizerResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetAuthorizerResponse.Builder,GetAuthorizerResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetAuthorizerResponse
extends ApiGatewayV2Response
implements ToCopyableBuilder<GetAuthorizerResponse.Builder,GetAuthorizerResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetAuthorizerResponse.Builder

Method Summary

Modifier and Type	Method and Description
String	authorizerCredentialsArn() Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
String	authorizerId() The authorizer identifier.
String	authorizerPayloadFormatVersion() Specifies the format of the payload sent to an HTTP API Lambda authorizer.
Integer	authorizerResultTtlInSeconds() The time to live (TTL) for cached authorizer results, in seconds.
AuthorizerType	authorizerType() The authorizer type.
String	authorizerTypeAsString() The authorizer type.
String	authorizerUri() The authorizer's Uniform Resource Identifier (URI).
static GetAuthorizerResponse.Builder	builder()
Boolean	enableSimpleResponses() Specifies whether a Lambda authorizer returns a response in a simple format.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
boolean	hasIdentitySource() Returns true if the IdentitySource property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<String>	identitySource() The identity source for which authorization is requested.
String	identityValidationExpression() The validation expression does not apply to the REQUEST authorizer.
JWTConfiguration	jwtConfiguration() Represents the configuration of a JWT authorizer.
String	name() The name of the authorizer.
List<SdkField<?>>	sdkFields()
static Class<? extends GetAuthorizerResponse.Builder>	serializableBuilderClass()
GetAuthorizerResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.apigatewayv2.model.ApiGatewayV2Response

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

authorizerCredentialsArn

public final 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.

Returns:

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.

authorizerId

public final String authorizerId()

The authorizer identifier.

Returns:

The authorizer identifier.

authorizerPayloadFormatVersion

public final 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.

Returns:

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.

authorizerResultTtlInSeconds

public final 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.

Returns:

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.

authorizerType

public final 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).

If the service returns an enum value that is not available in the current SDK version, authorizerType will return AuthorizerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authorizerTypeAsString().

Returns:

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).

See Also:

AuthorizerType

authorizerTypeAsString

public final String authorizerTypeAsString()

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).

If the service returns an enum value that is not available in the current SDK version, authorizerType will return AuthorizerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authorizerTypeAsString().

Returns:

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).

See Also:

AuthorizerType

authorizerUri

public final 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: {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:

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.

enableSimpleResponses

public final Boolean enableSimpleResponses()

Specifies whether a Lambda authorizer returns a response in a simple format. 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:

Specifies whether a Lambda authorizer returns a response in a simple format. 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

hasIdentitySource

public final boolean hasIdentitySource()

Returns true if the IdentitySource property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

identitySource

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasIdentitySource() to see if a value was sent in this field.

Returns:

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.

identityValidationExpression

public final String identityValidationExpression()

The validation expression does not apply to the REQUEST authorizer.

Returns:

The validation expression does not apply to the REQUEST authorizer.

jwtConfiguration

public final JWTConfiguration jwtConfiguration()

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

Returns:

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

name

public final String name()

The name of the authorizer.

Returns:

The name of the authorizer.

toBuilder

public GetAuthorizerResponse.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetAuthorizerResponse.Builder,GetAuthorizerResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static GetAuthorizerResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetAuthorizerResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.