Struct rusoto_apigatewayv2::GetAuthorizerResponse

pub struct GetAuthorizerResponse {
    pub authorizer_credentials_arn: Option<String>,
    pub authorizer_id: Option<String>,
    pub authorizer_result_ttl_in_seconds: Option<i64>,
    pub authorizer_type: Option<String>,
    pub authorizer_uri: Option<String>,
    pub identity_source: Option<Vec<String>>,
    pub identity_validation_expression: Option<String>,
    pub jwt_configuration: Option<JWTConfiguration>,
    pub name: Option<String>,
}

Fields

authorizer_credentials_arn: Option<String>

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.

authorizer_id: Option<String>

The authorizer identifier.

authorizer_result_ttl_in_seconds: Option<i64>

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

authorizer_type: Option<String>

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.

authorizer_uri: Option<String>

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.

identity_source: Option<Vec<String>>

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

identity_validation_expression: Option<String>

The validation expression does not apply to the REQUEST authorizer.

jwt_configuration: Option<JWTConfiguration>

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

name: Option<String>

The name of the authorizer.

Trait Implementations

impl Clone for GetAuthorizerResponse

pub fn clone(&self) -> GetAuthorizerResponse

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetAuthorizerResponse

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GetAuthorizerResponse

pub fn default() -> GetAuthorizerResponse

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for GetAuthorizerResponse

pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<GetAuthorizerResponse> for GetAuthorizerResponse

pub fn eq(&self, other: &GetAuthorizerResponse) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &GetAuthorizerResponse) -> bool

This method tests for !=.

impl StructuralPartialEq for GetAuthorizerResponse