« blib/lib/Paws/ApiGatewayV2/UpdateAuthorizerInput.pm
↑ Summary
blib/lib/Paws/ApiGatewayV2/UpdateDeployment.pm »
| 1 | |||
| 2 | package Paws::ApiGatewayV2::UpdateAuthorizerResponse; | ||
| 3 | use Moose; | ||
| 4 | has AuthorizerCredentialsArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'authorizerCredentialsArn'); | ||
| 5 | has AuthorizerId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'authorizerId'); | ||
| 6 | has AuthorizerPayloadFormatVersion => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'authorizerPayloadFormatVersion'); | ||
| 7 | has AuthorizerResultTtlInSeconds => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'authorizerResultTtlInSeconds'); | ||
| 8 | has AuthorizerType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'authorizerType'); | ||
| 9 | has AuthorizerUri => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'authorizerUri'); | ||
| 10 | has EnableSimpleResponses => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'enableSimpleResponses'); | ||
| 11 | has IdentitySource => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'identitySource'); | ||
| 12 | has IdentityValidationExpression => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'identityValidationExpression'); | ||
| 13 | has JwtConfiguration => (is => 'ro', isa => 'Paws::ApiGatewayV2::JWTConfiguration', traits => ['NameInRequest'], request_name => 'jwtConfiguration'); | ||
| 14 | has Name => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'name'); | ||
| 15 | |||
| 16 | has _request_id => (is => 'ro', isa => 'Str'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::ApiGatewayV2::UpdateAuthorizerResponse | ||
| 24 | |||
| 25 | =head1 ATTRIBUTES | ||
| 26 | |||
| 27 | |||
| 28 | =head2 AuthorizerCredentialsArn => Str | ||
| 29 | |||
| 30 | Specifies the required credentials as an IAM role for API Gateway to | ||
| 31 | invoke the authorizer. To specify an IAM role for API Gateway to | ||
| 32 | assume, use the role's Amazon Resource Name (ARN). To use | ||
| 33 | resource-based permissions on the Lambda function, don't specify this | ||
| 34 | parameter. Supported only for REQUEST authorizers. | ||
| 35 | |||
| 36 | |||
| 37 | =head2 AuthorizerId => Str | ||
| 38 | |||
| 39 | The authorizer identifier. | ||
| 40 | |||
| 41 | |||
| 42 | =head2 AuthorizerPayloadFormatVersion => Str | ||
| 43 | |||
| 44 | Specifies the format of the payload sent to an HTTP API Lambda | ||
| 45 | authorizer. Required for HTTP API Lambda authorizers. Supported values | ||
| 46 | are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers | ||
| 47 | for HTTP APIs | ||
| 48 | (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html). | ||
| 49 | |||
| 50 | |||
| 51 | =head2 AuthorizerResultTtlInSeconds => Int | ||
| 52 | |||
| 53 | The time to live (TTL) for cached authorizer results, in seconds. If it | ||
| 54 | equals 0, authorization caching is disabled. If it is greater than 0, | ||
| 55 | API Gateway caches authorizer responses. The maximum value is 3600, or | ||
| 56 | 1 hour. Supported only for HTTP API Lambda authorizers. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 AuthorizerType => Str | ||
| 60 | |||
| 61 | The authorizer type. Specify REQUEST for a Lambda function using | ||
| 62 | incoming request parameters. Specify JWT to use JSON Web Tokens | ||
| 63 | (supported only for HTTP APIs). | ||
| 64 | |||
| 65 | Valid values are: C<"REQUEST">, C<"JWT"> | ||
| 66 | =head2 AuthorizerUri => Str | ||
| 67 | |||
| 68 | The authorizer's Uniform Resource Identifier (URI). For REQUEST | ||
| 69 | authorizers, this must be a well-formed Lambda function URI, for | ||
| 70 | example, | ||
| 71 | 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. | ||
| 72 | In general, the URI has this form: | ||
| 73 | arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} | ||
| 74 | is the same as the region hosting the Lambda function, path indicates | ||
| 75 | that the remaining substring in the URI should be treated as the path | ||
| 76 | to the resource, including the initial /. For Lambda functions, this is | ||
| 77 | usually of the form /2015-03-31/functions/[FunctionARN]/invocations. | ||
| 78 | Supported only for REQUEST authorizers. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 EnableSimpleResponses => Bool | ||
| 82 | |||
| 83 | Specifies whether a Lambda authorizer returns a response in a simple | ||
| 84 | format. If enabled, the Lambda authorizer can return a boolean value | ||
| 85 | instead of an IAM policy. Supported only for HTTP APIs. To learn more, | ||
| 86 | see Working with AWS Lambda authorizers for HTTP APIs | ||
| 87 | (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html) | ||
| 88 | |||
| 89 | |||
| 90 | =head2 IdentitySource => ArrayRef[Str|Undef] | ||
| 91 | |||
| 92 | The identity source for which authorization is requested. | ||
| 93 | |||
| 94 | For a REQUEST authorizer, this is optional. The value is a set of one | ||
| 95 | or more mapping expressions of the specified request parameters. The | ||
| 96 | identity source can be headers, query string parameters, stage | ||
| 97 | variables, and context parameters. For example, if an Auth header and a | ||
| 98 | Name query string parameter are defined as identity sources, this value | ||
| 99 | is route.request.header.Auth, route.request.querystring.Name for | ||
| 100 | WebSocket APIs. For HTTP APIs, use selection expressions prefixed with | ||
| 101 | $, for example, $request.header.Auth, $request.querystring.Name. These | ||
| 102 | parameters are used to perform runtime validation for Lambda-based | ||
| 103 | authorizers by verifying all of the identity-related request parameters | ||
| 104 | are present in the request, not null, and non-empty. Only when this is | ||
| 105 | true does the authorizer invoke the authorizer Lambda function. | ||
| 106 | Otherwise, it returns a 401 Unauthorized response without calling the | ||
| 107 | Lambda function. For HTTP APIs, identity sources are also used as the | ||
| 108 | cache key when caching is enabled. To learn more, see Working with AWS | ||
| 109 | Lambda authorizers for HTTP APIs | ||
| 110 | (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html). | ||
| 111 | |||
| 112 | For JWT, a single entry that specifies where to extract the JSON Web | ||
| 113 | Token (JWT) from inbound requests. Currently only header-based and | ||
| 114 | query parameter-based selections are supported, for example | ||
| 115 | $request.header.Authorization. | ||
| 116 | |||
| 117 | |||
| 118 | =head2 IdentityValidationExpression => Str | ||
| 119 | |||
| 120 | The validation expression does not apply to the REQUEST authorizer. | ||
| 121 | |||
| 122 | |||
| 123 | =head2 JwtConfiguration => L<Paws::ApiGatewayV2::JWTConfiguration> | ||
| 124 | |||
| 125 | Represents the configuration of a JWT authorizer. Required for the JWT | ||
| 126 | authorizer type. Supported only for HTTP APIs. | ||
| 127 | |||
| 128 | |||
| 129 | =head2 Name => Str | ||
| 130 | |||
| 131 | The name of the authorizer. | ||
| 132 | |||
| 133 | |||
| 134 | =head2 _request_id => Str | ||
| 135 | |||
| 136 | |||
| 137 | =cut | ||
| 138 |