UpdateAuthorizerRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.apigatewayv2.model.ApiGatewayV2Request
    - - software.amazon.awssdk.services.apigatewayv2.model.UpdateAuthorizerRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<UpdateAuthorizerRequest.Builder,UpdateAuthorizerRequest>

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

Updates an Authorizer.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface UpdateAuthorizerRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`UpdateAuthorizerRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`apiId()` The API identifier.
`String`	`authorizerCredentialsArn()` Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
`String`	`authorizerId()` The authorizer identifier.
`Integer`	`authorizerResultTtlInSeconds()` Authorizer caching is not currently supported.
`AuthorizerType`	`authorizerType()` The authorizer type.
`String`	`authorizerTypeAsString()` The authorizer type.
`String`	`authorizerUri()` The authorizer's Uniform Resource Identifier (URI).
`static UpdateAuthorizerRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`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()` This parameter is not used.
`JWTConfiguration`	`jwtConfiguration()` Represents the configuration of a JWT authorizer.
`String`	`name()` The name of the authorizer.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends UpdateAuthorizerRequest.Builder>`	`serializableBuilderClass()`
`UpdateAuthorizerRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - apiId
```
public String apiId()
```
    The API identifier.
    
    Returns:
    
    The API identifier.
  - authorizerCredentialsArn
```
public 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.
    
    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, specify null.
  - authorizerId
```
public String authorizerId()
```
    The authorizer identifier.
    
    Returns:
    
    The authorizer identifier.
  - authorizerResultTtlInSeconds
```
public Integer authorizerResultTtlInSeconds()
```
    Authorizer caching is not currently supported. Don't specify this value for authorizers.
    
    Returns:
    
    Authorizer caching is not currently supported. Don't specify this value for authorizers.
  - authorizerType
```
public AuthorizerType authorizerType()
```
    The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.
    
    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. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.
    
    See Also:
    
    AuthorizerType
  - authorizerTypeAsString
```
public String authorizerTypeAsString()
```
    The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.
    
    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. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.
    
    See Also:
    
    AuthorizerType
  - authorizerUri
```
public 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.
  - hasIdentitySource
```
public 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 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. Currently, 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. These parameters will be 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 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. Currently, 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. These parameters will be 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 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 String identityValidationExpression()
```
    This parameter is not used.
    
    Returns:
    
    This parameter is not used.
  - jwtConfiguration
```
public 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 String name()
```
    The name of the authorizer.
    
    Returns:
    
    The name of the authorizer.
  - toBuilder
```
public UpdateAuthorizerRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateAuthorizerRequest.Builder,UpdateAuthorizerRequest>
    
    Specified by:
    
    toBuilder in class ApiGatewayV2Request
  - builder
```
public static UpdateAuthorizerRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateAuthorizerRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class UpdateAuthorizerRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

apiId

authorizerCredentialsArn

authorizerId

authorizerResultTtlInSeconds

authorizerType

authorizerTypeAsString

authorizerUri

hasIdentitySource

identitySource

identityValidationExpression

jwtConfiguration

name

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields