« blib/lib/Paws/ApiGatewayV2/ResponseParameters.pm
↑ Summary
blib/lib/Paws/ApiGatewayV2/RouteModels.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ApiGatewayV2::Route; | ||
| 3 | use Moose; | ||
| 4 | has ApiGatewayManaged => (is => 'ro', isa => 'Bool', request_name => 'apiGatewayManaged', traits => ['NameInRequest']); | ||
| 5 | has ApiKeyRequired => (is => 'ro', isa => 'Bool', request_name => 'apiKeyRequired', traits => ['NameInRequest']); | ||
| 6 | has AuthorizationScopes => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'authorizationScopes', traits => ['NameInRequest']); | ||
| 7 | has AuthorizationType => (is => 'ro', isa => 'Str', request_name => 'authorizationType', traits => ['NameInRequest']); | ||
| 8 | has AuthorizerId => (is => 'ro', isa => 'Str', request_name => 'authorizerId', traits => ['NameInRequest']); | ||
| 9 | has ModelSelectionExpression => (is => 'ro', isa => 'Str', request_name => 'modelSelectionExpression', traits => ['NameInRequest']); | ||
| 10 | has OperationName => (is => 'ro', isa => 'Str', request_name => 'operationName', traits => ['NameInRequest']); | ||
| 11 | has RequestModels => (is => 'ro', isa => 'Paws::ApiGatewayV2::RouteModels', request_name => 'requestModels', traits => ['NameInRequest']); | ||
| 12 | has RequestParameters => (is => 'ro', isa => 'Paws::ApiGatewayV2::RouteParameters', request_name => 'requestParameters', traits => ['NameInRequest']); | ||
| 13 | has RouteId => (is => 'ro', isa => 'Str', request_name => 'routeId', traits => ['NameInRequest']); | ||
| 14 | has RouteKey => (is => 'ro', isa => 'Str', request_name => 'routeKey', traits => ['NameInRequest'], required => 1); | ||
| 15 | has RouteResponseSelectionExpression => (is => 'ro', isa => 'Str', request_name => 'routeResponseSelectionExpression', traits => ['NameInRequest']); | ||
| 16 | has Target => (is => 'ro', isa => 'Str', request_name => 'target', traits => ['NameInRequest']); | ||
| 17 | |||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::ApiGatewayV2::Route | ||
| 25 | |||
| 26 | =head1 USAGE | ||
| 27 | |||
| 28 | This class represents one of two things: | ||
| 29 | |||
| 30 | =head3 Arguments in a call to a service | ||
| 31 | |||
| 32 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 33 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 34 | |||
| 35 | As an example, if Att1 is expected to be a Paws::ApiGatewayV2::Route object: | ||
| 36 | |||
| 37 | $service_obj->Method(Att1 => { ApiGatewayManaged => $value, ..., Target => $value }); | ||
| 38 | |||
| 39 | =head3 Results returned from an API call | ||
| 40 | |||
| 41 | Use accessors for each attribute. If Att1 is expected to be an Paws::ApiGatewayV2::Route object: | ||
| 42 | |||
| 43 | $result = $service_obj->Method(...); | ||
| 44 | $result->Att1->ApiGatewayManaged | ||
| 45 | |||
| 46 | =head1 DESCRIPTION | ||
| 47 | |||
| 48 | Represents a route. | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 ApiGatewayManaged => Bool | ||
| 54 | |||
| 55 | Specifies whether a route is managed by API Gateway. If you created an | ||
| 56 | API using quick create, the $default route is managed by API Gateway. | ||
| 57 | You can't modify the $default route key. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 ApiKeyRequired => Bool | ||
| 61 | |||
| 62 | Specifies whether an API key is required for this route. Supported only | ||
| 63 | for WebSocket APIs. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 AuthorizationScopes => ArrayRef[Str|Undef] | ||
| 67 | |||
| 68 | A list of authorization scopes configured on a route. The scopes are | ||
| 69 | used with a JWT authorizer to authorize the method invocation. The | ||
| 70 | authorization works by matching the route scopes against the scopes | ||
| 71 | parsed from the access token in the incoming request. The method | ||
| 72 | invocation is authorized if any route scope matches a claimed scope in | ||
| 73 | the access token. Otherwise, the invocation is not authorized. When the | ||
| 74 | route scope is configured, the client must provide an access token | ||
| 75 | instead of an identity token for authorization purposes. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 AuthorizationType => Str | ||
| 79 | |||
| 80 | The authorization type for the route. For WebSocket APIs, valid values | ||
| 81 | are NONE for open access, AWS_IAM for using AWS IAM permissions, and | ||
| 82 | CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are | ||
| 83 | NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using | ||
| 84 | AWS IAM permissions, and CUSTOM for using a Lambda authorizer. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 AuthorizerId => Str | ||
| 88 | |||
| 89 | The identifier of the Authorizer resource to be associated with this | ||
| 90 | route. The authorizer identifier is generated by API Gateway when you | ||
| 91 | created the authorizer. | ||
| 92 | |||
| 93 | |||
| 94 | =head2 ModelSelectionExpression => Str | ||
| 95 | |||
| 96 | The model selection expression for the route. Supported only for | ||
| 97 | WebSocket APIs. | ||
| 98 | |||
| 99 | |||
| 100 | =head2 OperationName => Str | ||
| 101 | |||
| 102 | The operation name for the route. | ||
| 103 | |||
| 104 | |||
| 105 | =head2 RequestModels => L<Paws::ApiGatewayV2::RouteModels> | ||
| 106 | |||
| 107 | The request models for the route. Supported only for WebSocket APIs. | ||
| 108 | |||
| 109 | |||
| 110 | =head2 RequestParameters => L<Paws::ApiGatewayV2::RouteParameters> | ||
| 111 | |||
| 112 | The request parameters for the route. Supported only for WebSocket | ||
| 113 | APIs. | ||
| 114 | |||
| 115 | |||
| 116 | =head2 RouteId => Str | ||
| 117 | |||
| 118 | The route ID. | ||
| 119 | |||
| 120 | |||
| 121 | =head2 B<REQUIRED> RouteKey => Str | ||
| 122 | |||
| 123 | The route key for the route. | ||
| 124 | |||
| 125 | |||
| 126 | =head2 RouteResponseSelectionExpression => Str | ||
| 127 | |||
| 128 | The route response selection expression for the route. Supported only | ||
| 129 | for WebSocket APIs. | ||
| 130 | |||
| 131 | |||
| 132 | =head2 Target => Str | ||
| 133 | |||
| 134 | The target for the route. | ||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | =head1 SEE ALSO | ||
| 139 | |||
| 140 | This class forms part of L<Paws>, describing an object used in L<Paws::ApiGatewayV2> | ||
| 141 | |||
| 142 | =head1 BUGS and CONTRIBUTIONS | ||
| 143 | |||
| 144 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 145 | |||
| 146 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 147 | |||
| 148 | =cut | ||
| 149 |