GetAuthorizerResponse (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.AmazonWebServiceResult<ResponseMetadata>
- - software.amazon.awssdk.services.apigateway.model.GetAuthorizerResponse

All Implemented Interfaces:

ToCopyableBuilder<GetAuthorizerResponse.Builder,GetAuthorizerResponse>
```
@Generated("software.amazon.awssdk:codegen")
public class GetAuthorizerResponse
extends AmazonWebServiceResult<ResponseMetadata>
implements ToCopyableBuilder<GetAuthorizerResponse.Builder,GetAuthorizerResponse>
```
Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.

Enable custom authorization

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface GetAuthorizerResponse.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`authorizerCredentials()`	Specifies the credentials required for the authorizer, if any.
`Integer`	`authorizerResultTtlInSeconds()`	The TTL in seconds of cached authorizer results.
`String`	`authorizerUri()`	[Required] Specifies the authorizer's Uniform Resource Identifier (URI).
`String`	`authType()`	Optional customer-defined field, used in Swagger imports/exports.
`static GetAuthorizerResponse.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`int`	`hashCode()`
`String`	`id()`	The identifier for the authorizer resource.
`String`	`identitySource()`	[Required] The source of the identity in an incoming request.
`String`	`identityValidationExpression()`	A validation expression for the incoming identity.
`String`	`name()`	[Required] The name of the authorizer.
`List<String>`	`providerARNs()`	A list of the provider ARNs of the authorizer.
`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()`
`String`	`type()`	[Required] The type of the authorizer.

Methods inherited from class software.amazon.awssdk.AmazonWebServiceResult
setSdkHttpMetadata, setSdkResponseMetadata

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

- Method Detail
  - id
```
public String id()
```
    The identifier for the authorizer resource.
    
    Returns:
    
    The identifier for the authorizer resource.
  - name
```
public String name()
```
    [Required] The name of the authorizer.
    
    Returns:
    
    [Required] The name of the authorizer.
  - type
```
public String type()
```
    [Required] The type of the authorizer. Currently, the valid type is TOKEN for a Lambda function or COGNITO_USER_POOLS for an Amazon Cognito user pool.
    
    Returns:
    
    [Required] The type of the authorizer. Currently, the valid type is TOKEN for a Lambda function or COGNITO_USER_POOLS for an Amazon Cognito user pool.
    
    See Also:
    
    AuthorizerType
  - providerARNs
```
public List<String> providerARNs()
```
    A list of the provider ARNs of the authorizer. For an TOKEN authorizer, this is not defined. For authorizers of the COGNITO_USER_POOLS type, each element corresponds to a user pool ARN of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}.
    
    Returns:
    
    A list of the provider ARNs of the authorizer. For an TOKEN authorizer, this is not defined. For authorizers of the COGNITO_USER_POOLS type, each element corresponds to a user pool ARN of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}.
  - authType
```
public String authType()
```
    Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.
    
    Returns:
    
    Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.
  - authorizerUri
```
public String authorizerUri()
```
    [Required] Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN 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:
    
    [Required] Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN 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.
  - authorizerCredentials
```
public String authorizerCredentials()
```
    Specifies the credentials required for the authorizer, if any. Two options are available. To specify an IAM role for Amazon 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 credentials required for the authorizer, if any. Two options are available. To specify an IAM role for Amazon API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
  - identitySource
```
public String identitySource()
```
    [Required] The source of the identity in an incoming request. For a TOKEN authorizer, this value is a mapping expression with the same syntax as integration parameter mappings. The only valid source for tokens is 'header', so the expression should match 'method.request.header.[headerName]'. The value of the header '[headerName]' will be interpreted as the incoming token. For COGNITO_USER_POOLS authorizers, this property is used.
    
    Returns:
    
    [Required] The source of the identity in an incoming request. For a TOKEN authorizer, this value is a mapping expression with the same syntax as integration parameter mappings. The only valid source for tokens is 'header', so the expression should match 'method.request.header.[headerName]'. The value of the header '[headerName]' will be interpreted as the incoming token. For COGNITO_USER_POOLS authorizers, this property is used.
  - identityValidationExpression
```
public String identityValidationExpression()
```
    A validation expression for the incoming identity. For TOKEN authorizers, this value should be a regular expression. The incoming token from the client is matched against this expression, and will proceed if the token matches. If the token doesn't match, the client receives a 401 Unauthorized response.
    
    Returns:
    
    A validation expression for the incoming identity. For TOKEN authorizers, this value should be a regular expression. The incoming token from the client is matched against this expression, and will proceed if the token matches. If the token doesn't match, the client receives a 401 Unauthorized response.
  - authorizerResultTtlInSeconds
```
public Integer authorizerResultTtlInSeconds()
```
    The TTL in seconds of cached authorizer results. If 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:
    
    The TTL in seconds of cached authorizer results. If 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.
  - 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>
    
    Returns:
    
    a builder for type T
  - builder
```
public static GetAuthorizerResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetAuthorizerResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class GetAuthorizerResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Method Detail

id

name

type

providerARNs

authType

authorizerUri

authorizerCredentials

identitySource

identityValidationExpression

authorizerResultTtlInSeconds

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString