@Generated(value="software.amazon.awssdk:codegen") public final class GetAuthorizerResponse extends ApiGatewayV2Response implements ToCopyableBuilder<GetAuthorizerResponse.Builder,GetAuthorizerResponse>
| Modifier and Type | Class and Description |
|---|---|
static interface |
GetAuthorizerResponse.Builder |
| 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()
For responses, this returns true if the service returned a value for the IdentitySource property.
|
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.
|
responseMetadatasdkHttpResponsecopypublic 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.
public final String authorizerId()
The authorizer identifier.
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.
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.
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().
AuthorizerTypepublic 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().
AuthorizerTypepublic 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:
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
public final boolean hasIdentitySource()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasIdentitySource() method.
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.
public final String identityValidationExpression()
The validation expression does not apply to the REQUEST authorizer.
public final JWTConfiguration jwtConfiguration()
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
public final String name()
The name of the authorizer.
public GetAuthorizerResponse.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<GetAuthorizerResponse.Builder,GetAuthorizerResponse>toBuilder in class AwsResponsepublic static GetAuthorizerResponse.Builder builder()
public static Class<? extends GetAuthorizerResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo 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.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponseSdkResponse. 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.getValueForField in class SdkResponsefieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.