NAME

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

DESCRIPTION

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.

SYNOPSIS

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

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

    # 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 https://docs.aws.amazon.com/goto/WebAPI/apigateway/CreateAuthorizer

ATTRIBUTES

REQUIRED ApiId => Str

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, don't specify this parameter. Supported only for REQUEST authorizers.

AuthorizerPayloadFormatVersion => Str

Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).

AuthorizerResultTtlInSeconds => Int

The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

REQUIRED AuthorizerType => Str

The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

Valid values are: "REQUEST", "JWT"

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

EnableSimpleResponses => Bool

Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html)

REQUIRED IdentitySource => ArrayRef[Str|Undef]

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. 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 for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are 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 HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).

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.

IdentityValidationExpression => Str

This parameter is not used.

JwtConfiguration => Paws::ApiGatewayV2::JWTConfiguration

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

REQUIRED Name => Str

The name of the authorizer.

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateAuthorizer 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

cpanm Paws

perl -MCPAN -e shell
install Paws