Paws::ApiGatewayV2::CreateAuthorizer - Arguments for method CreateAuthorizer on Paws::ApiGatewayV2


This class represents the parameters used for calling the method CreateAuthorizer on the AmazonApiGatewayV2 service. Use the attributes of this class as arguments to method CreateAuthorizer.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateAuthorizer.


    my $apigateway = Paws->service('ApiGatewayV2');
    my $CreateAuthorizerResponse = $apigateway->CreateAuthorizer(
      ApiId                    => 'My__string',
      AuthorizerType           => 'REQUEST',
      AuthorizerUri            => 'MyUriWithLengthBetween1And2048',
      IdentitySource           => [ 'My__string', ... ],
      Name                     => 'MyStringWithLengthBetween1And128',
      AuthorizerCredentialsArn => 'MyArn',                            # OPTIONAL
      AuthorizerResultTtlInSeconds => 1,                              # OPTIONAL
      IdentityValidationExpression =>
        'MyStringWithLengthBetween0And1024',                          # OPTIONAL
      ProviderArns => [ 'MyArn', ... ],                               # OPTIONAL

    # Results:
    my $AuthorizerCredentialsArn =
    my $AuthorizerId = $CreateAuthorizerResponse->AuthorizerId;
    my $AuthorizerResultTtlInSeconds =
    my $AuthorizerType = $CreateAuthorizerResponse->AuthorizerType;
    my $AuthorizerUri  = $CreateAuthorizerResponse->AuthorizerUri;
    my $IdentitySource = $CreateAuthorizerResponse->IdentitySource;
    my $IdentityValidationExpression =
    my $Name         = $CreateAuthorizerResponse->Name;
    my $ProviderArns = $CreateAuthorizerResponse->ProviderArns;

    # Returns a L<Paws::ApiGatewayV2::CreateAuthorizerResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see



The API identifier.

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

REQUIRED AuthorizerType => Str

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

Valid values are: "REQUEST"

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

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

IdentityValidationExpression => Str

The validation expression does not apply to the REQUEST authorizer.

REQUIRED Name => Str

The name of the authorizer.

ProviderArns => ArrayRef[Str|Undef]

For REQUEST authorizer, this is not defined.


This class forms part of Paws, documenting arguments for method CreateAuthorizer in Paws::ApiGatewayV2


The source code is located here:

Please report bugs to: