com.amazonaws.services.apigatewayv2.model

Class GetAuthorizerResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.apigatewayv2.model.GetAuthorizerResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetAuthorizerResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetAuthorizerResult()

Method Summary

Modifier and Type	Method and Description
GetAuthorizerResult	clone()
boolean	equals(Object obj)
String	getAuthorizerCredentialsArn() Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
String	getAuthorizerId() The authorizer identifier.
Integer	getAuthorizerResultTtlInSeconds() Authorizer caching is not currently supported.
String	getAuthorizerType() The authorizer type.
String	getAuthorizerUri() The authorizer's Uniform Resource Identifier (URI).
List<String>	getIdentitySource() The identity source for which authorization is requested.
String	getIdentityValidationExpression() The validation expression does not apply to the REQUEST authorizer.
JWTConfiguration	getJwtConfiguration() Represents the configuration of a JWT authorizer.
String	getName() The name of the authorizer.
int	hashCode()
void	setAuthorizerCredentialsArn(String authorizerCredentialsArn) Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
void	setAuthorizerId(String authorizerId) The authorizer identifier.
void	setAuthorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds) Authorizer caching is not currently supported.
void	setAuthorizerType(String authorizerType) The authorizer type.
void	setAuthorizerUri(String authorizerUri) The authorizer's Uniform Resource Identifier (URI).
void	setIdentitySource(Collection<String> identitySource) The identity source for which authorization is requested.
void	setIdentityValidationExpression(String identityValidationExpression) The validation expression does not apply to the REQUEST authorizer.
void	setJwtConfiguration(JWTConfiguration jwtConfiguration) Represents the configuration of a JWT authorizer.
void	setName(String name) The name of the authorizer.
String	toString() Returns a string representation of this object.
GetAuthorizerResult	withAuthorizerCredentialsArn(String authorizerCredentialsArn) Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
GetAuthorizerResult	withAuthorizerId(String authorizerId) The authorizer identifier.
GetAuthorizerResult	withAuthorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds) Authorizer caching is not currently supported.
GetAuthorizerResult	withAuthorizerType(AuthorizerType authorizerType) The authorizer type.
GetAuthorizerResult	withAuthorizerType(String authorizerType) The authorizer type.
GetAuthorizerResult	withAuthorizerUri(String authorizerUri) The authorizer's Uniform Resource Identifier (URI).
GetAuthorizerResult	withIdentitySource(Collection<String> identitySource) The identity source for which authorization is requested.
GetAuthorizerResult	withIdentitySource(String... identitySource) The identity source for which authorization is requested.
GetAuthorizerResult	withIdentityValidationExpression(String identityValidationExpression) The validation expression does not apply to the REQUEST authorizer.
GetAuthorizerResult	withJwtConfiguration(JWTConfiguration jwtConfiguration) Represents the configuration of a JWT authorizer.
GetAuthorizerResult	withName(String name) The name of the authorizer.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetAuthorizerResult

public GetAuthorizerResult()

Method Detail

setAuthorizerCredentialsArn

public void setAuthorizerCredentialsArn(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. Supported only for REQUEST authorizers.

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. Supported only for REQUEST authorizers.

getAuthorizerCredentialsArn

public String getAuthorizerCredentialsArn()

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. 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, specify null. Supported only for REQUEST authorizers.

withAuthorizerCredentialsArn

public GetAuthorizerResult withAuthorizerCredentialsArn(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. Supported only for REQUEST authorizers.

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. Supported only for REQUEST authorizers.

Returns:

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

setAuthorizerId

public void setAuthorizerId(String authorizerId)

The authorizer identifier.

Parameters:

authorizerId - The authorizer identifier.

getAuthorizerId

public String getAuthorizerId()

The authorizer identifier.

Returns:

The authorizer identifier.

withAuthorizerId

public GetAuthorizerResult withAuthorizerId(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.

setAuthorizerResultTtlInSeconds

public void setAuthorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds)

Authorizer caching is not currently supported. Don't specify this value for authorizers.

Parameters:

authorizerResultTtlInSeconds - Authorizer caching is not currently supported. Don't specify this value for authorizers.

getAuthorizerResultTtlInSeconds

public Integer getAuthorizerResultTtlInSeconds()

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.

withAuthorizerResultTtlInSeconds

public GetAuthorizerResult withAuthorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds)

Authorizer caching is not currently supported. Don't specify this value for authorizers.

Parameters:

authorizerResultTtlInSeconds - Authorizer caching is not currently supported. Don't specify this value for authorizers.

Returns:

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

setAuthorizerType

public void setAuthorizerType(String 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.

Parameters:

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.

See Also:

AuthorizerType

getAuthorizerType

public String getAuthorizerType()

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.

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

withAuthorizerType

public GetAuthorizerResult withAuthorizerType(String 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.

Parameters:

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.

Returns:

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

See Also:

AuthorizerType

withAuthorizerType

public GetAuthorizerResult withAuthorizerType(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.

Parameters:

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.

Returns:

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

See Also:

AuthorizerType

setAuthorizerUri

public void setAuthorizerUri(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. Supported only for REQUEST authorizers.

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. Supported only for REQUEST authorizers.

getAuthorizerUri

public String getAuthorizerUri()

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. Supported only for REQUEST authorizers.

Returns:

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. Supported only for REQUEST authorizers.

withAuthorizerUri

public GetAuthorizerResult withAuthorizerUri(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. Supported only for REQUEST authorizers.

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. Supported only for REQUEST authorizers.

Returns:

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

getIdentitySource

public List<String> getIdentitySource()

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

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

setIdentitySource

public void setIdentitySource(Collection<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".

Parameters:

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

withIdentitySource

public GetAuthorizerResult withIdentitySource(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".

NOTE: This method appends the values to the existing list (if any). Use setIdentitySource(java.util.Collection) or withIdentitySource(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

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

withIdentitySource

public GetAuthorizerResult withIdentitySource(Collection<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".

Parameters:

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

Returns:

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

setIdentityValidationExpression

public void setIdentityValidationExpression(String identityValidationExpression)

The validation expression does not apply to the REQUEST authorizer.

Parameters:

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

getIdentityValidationExpression

public String getIdentityValidationExpression()

The validation expression does not apply to the REQUEST authorizer.

Returns:

The validation expression does not apply to the REQUEST authorizer.

withIdentityValidationExpression

public GetAuthorizerResult withIdentityValidationExpression(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.

setJwtConfiguration

public void setJwtConfiguration(JWTConfiguration jwtConfiguration)

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

Parameters:

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

getJwtConfiguration

public JWTConfiguration getJwtConfiguration()

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.

withJwtConfiguration

public GetAuthorizerResult withJwtConfiguration(JWTConfiguration jwtConfiguration)

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

Parameters:

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

Returns:

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

setName

public void setName(String name)

The name of the authorizer.

Parameters:

name - The name of the authorizer.

getName

public String getName()

The name of the authorizer.

Returns:

The name of the authorizer.

withName

public GetAuthorizerResult withName(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.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetAuthorizerResult clone()

Overrides:

clone in class Object