Struct rusoto_apigatewayv2::CreateAuthorizerInput

pub struct CreateAuthorizerInput {
    pub authorizer_credentials_arn: Option<String>,
    pub authorizer_result_ttl_in_seconds: Option<i64>,
    pub authorizer_type: String,
    pub authorizer_uri: String,
    pub identity_source: Vec<String>,
    pub identity_validation_expression: Option<String>,
    pub name: String,
    pub provider_arns: Option<Vec<String>>,
}

Represents the input parameters for a CreateAuthorizer request.

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.

authorizer_result_ttl_in_seconds: Option<i64>

The time to live (TTL), in seconds, of cached authorizer results. If it equals 0, authorization caching is disabled. If it is 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.

authorizer_type: String

The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.

authorizer_uri: String

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.

identity_source: Vec<String>

The identity source for which authorization is requested.

For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header and a Name query string parameters are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, 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. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

identity_validation_expression: Option<String>

The validation expression does not apply to the REQUEST authorizer.

name: String

The name of the authorizer.

provider_arns: Option<Vec<String>>

For REQUEST authorizer, this is not defined.

Trait Implementations

impl PartialEq<CreateAuthorizerInput> for CreateAuthorizerInput

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

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

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

This method tests for !=.

impl Default for CreateAuthorizerInput

fn default() -> CreateAuthorizerInput

Returns the "default value" for a type.

impl Clone for CreateAuthorizerInput

fn clone(&self) -> CreateAuthorizerInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateAuthorizerInput

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.