NAME
Paws::ApiGatewayV2::UpdateAuthorizerInput
USAGE
This class represents one of two things:
Arguments in a call to a service
Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.
As an example, if Att1 is expected to be a Paws::ApiGatewayV2::UpdateAuthorizerInput object:
$service_obj->Method(Att1 => { AuthorizerCredentialsArn => $value, ..., ProviderArns => $value });Results returned from an API call
Use accessors for each attribute. If Att1 is expected to be an Paws::ApiGatewayV2::UpdateAuthorizerInput object:
$result = $service_obj->Method(...);
$result->Att1->AuthorizerCredentialsArnDESCRIPTION
The input parameters for an UpdateAuthorizer request.
ATTRIBUTES
AuthorizerCredentialsArn => Str
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.AuthorizerResultTtlInSeconds => Int
The time to live (TTL), in seconds, of cached authorizer results. If it
is zero, authorization caching is disabled. If it is greater than zero,
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.AuthorizerType => Str
The authorizer type. Currently the only valid value is REQUEST, for a
Lambda function using incoming request parameters.AuthorizerUri => Str
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.IdentitySource => ArrayRef[Str|Undef]
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, a Name query string parameter 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.
IdentityValidationExpression => Str
The validation expression does not apply to the REQUEST authorizer.Name => Str
The name of the authorizer.ProviderArns => ArrayRef[Str|Undef]
For REQUEST authorizer, this is not defined.SEE ALSO
This class forms part of Paws, describing an object used in Paws::ApiGatewayV2
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues