« blib/lib/Paws/ApiGatewayV2/GetRouteResponsesResponse.pm
↑ Summary
blib/lib/Paws/ApiGatewayV2/GetRoutes.pm »
| 1 | |||
| 2 | package Paws::ApiGatewayV2::GetRouteResult; | ||
| 3 | use Moose; | ||
| 4 | has ApiGatewayManaged => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'apiGatewayManaged'); | ||
| 5 | has ApiKeyRequired => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'apiKeyRequired'); | ||
| 6 | has AuthorizationScopes => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'authorizationScopes'); | ||
| 7 | has AuthorizationType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'authorizationType'); | ||
| 8 | has AuthorizerId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'authorizerId'); | ||
| 9 | has ModelSelectionExpression => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'modelSelectionExpression'); | ||
| 10 | has OperationName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'operationName'); | ||
| 11 | has RequestModels => (is => 'ro', isa => 'Paws::ApiGatewayV2::RouteModels', traits => ['NameInRequest'], request_name => 'requestModels'); | ||
| 12 | has RequestParameters => (is => 'ro', isa => 'Paws::ApiGatewayV2::RouteParameters', traits => ['NameInRequest'], request_name => 'requestParameters'); | ||
| 13 | has RouteId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'routeId'); | ||
| 14 | has RouteKey => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'routeKey'); | ||
| 15 | has RouteResponseSelectionExpression => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'routeResponseSelectionExpression'); | ||
| 16 | has Target => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'target'); | ||
| 17 | |||
| 18 | has _request_id => (is => 'ro', isa => 'Str'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::ApiGatewayV2::GetRouteResult | ||
| 26 | |||
| 27 | =head1 ATTRIBUTES | ||
| 28 | |||
| 29 | |||
| 30 | =head2 ApiGatewayManaged => Bool | ||
| 31 | |||
| 32 | Specifies whether a route is managed by API Gateway. If you created an | ||
| 33 | API using quick create, the $default route is managed by API Gateway. | ||
| 34 | You can't modify the $default route key. | ||
| 35 | |||
| 36 | |||
| 37 | =head2 ApiKeyRequired => Bool | ||
| 38 | |||
| 39 | Specifies whether an API key is required for this route. Supported only | ||
| 40 | for WebSocket APIs. | ||
| 41 | |||
| 42 | |||
| 43 | =head2 AuthorizationScopes => ArrayRef[Str|Undef] | ||
| 44 | |||
| 45 | A list of authorization scopes configured on a route. The scopes are | ||
| 46 | used with a JWT authorizer to authorize the method invocation. The | ||
| 47 | authorization works by matching the route scopes against the scopes | ||
| 48 | parsed from the access token in the incoming request. The method | ||
| 49 | invocation is authorized if any route scope matches a claimed scope in | ||
| 50 | the access token. Otherwise, the invocation is not authorized. When the | ||
| 51 | route scope is configured, the client must provide an access token | ||
| 52 | instead of an identity token for authorization purposes. | ||
| 53 | |||
| 54 | |||
| 55 | =head2 AuthorizationType => Str | ||
| 56 | |||
| 57 | The authorization type for the route. For WebSocket APIs, valid values | ||
| 58 | are NONE for open access, AWS_IAM for using AWS IAM permissions, and | ||
| 59 | CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are | ||
| 60 | NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using | ||
| 61 | AWS IAM permissions, and CUSTOM for using a Lambda authorizer. | ||
| 62 | |||
| 63 | Valid values are: C<"NONE">, C<"AWS_IAM">, C<"CUSTOM">, C<"JWT"> | ||
| 64 | =head2 AuthorizerId => Str | ||
| 65 | |||
| 66 | The identifier of the Authorizer resource to be associated with this | ||
| 67 | route. The authorizer identifier is generated by API Gateway when you | ||
| 68 | created the authorizer. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 ModelSelectionExpression => Str | ||
| 72 | |||
| 73 | The model selection expression for the route. Supported only for | ||
| 74 | WebSocket APIs. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 OperationName => Str | ||
| 78 | |||
| 79 | The operation name for the route. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 RequestModels => L<Paws::ApiGatewayV2::RouteModels> | ||
| 83 | |||
| 84 | The request models for the route. Supported only for WebSocket APIs. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 RequestParameters => L<Paws::ApiGatewayV2::RouteParameters> | ||
| 88 | |||
| 89 | The request parameters for the route. Supported only for WebSocket | ||
| 90 | APIs. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 RouteId => Str | ||
| 94 | |||
| 95 | The route ID. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 RouteKey => Str | ||
| 99 | |||
| 100 | The route key for the route. | ||
| 101 | |||
| 102 | |||
| 103 | =head2 RouteResponseSelectionExpression => Str | ||
| 104 | |||
| 105 | The route response selection expression for the route. Supported only | ||
| 106 | for WebSocket APIs. | ||
| 107 | |||
| 108 | |||
| 109 | =head2 Target => Str | ||
| 110 | |||
| 111 | The target for the route. | ||
| 112 | |||
| 113 | |||
| 114 | =head2 _request_id => Str | ||
| 115 | |||
| 116 | |||
| 117 | =cut | ||
| 118 |