« blib/lib/Paws/ApiGatewayV2/CreateModelResponse.pm
↑ Summary
blib/lib/Paws/ApiGatewayV2/CreateRouteInput.pm »
| 1 | |||
| 2 | package Paws::ApiGatewayV2::CreateRoute; | ||
| 3 | use Moose; | ||
| 4 | has ApiId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'apiId', required => 1); | ||
| 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 RouteKey => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'routeKey', required => 1); | ||
| 14 | has RouteResponseSelectionExpression => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'routeResponseSelectionExpression'); | ||
| 15 | has Target => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'target'); | ||
| 16 | |||
| 17 | use MooseX::ClassAttribute; | ||
| 18 | |||
| 19 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateRoute'); | ||
| 20 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v2/apis/{apiId}/routes'); | ||
| 21 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 22 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGatewayV2::CreateRouteResponseShape'); | ||
| 23 | 1; | ||
| 24 | |||
| 25 | ### main pod documentation begin ### | ||
| 26 | |||
| 27 | =head1 NAME | ||
| 28 | |||
| 29 | Paws::ApiGatewayV2::CreateRoute - Arguments for method CreateRoute on L<Paws::ApiGatewayV2> | ||
| 30 | |||
| 31 | =head1 DESCRIPTION | ||
| 32 | |||
| 33 | This class represents the parameters used for calling the method CreateRoute on the | ||
| 34 | L<AmazonApiGatewayV2|Paws::ApiGatewayV2> service. Use the attributes of this class | ||
| 35 | as arguments to method CreateRoute. | ||
| 36 | |||
| 37 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateRoute. | ||
| 38 | |||
| 39 | =head1 SYNOPSIS | ||
| 40 | |||
| 41 | my $apigateway = Paws->service('ApiGatewayV2'); | ||
| 42 | my $CreateRouteResponseShape = $apigateway->CreateRoute( | ||
| 43 | ApiId => 'My__string', | ||
| 44 | RouteKey => 'MySelectionKey', | ||
| 45 | ApiKeyRequired => 1, # OPTIONAL | ||
| 46 | AuthorizationScopes => [ 'MyStringWithLengthBetween1And64', ... ] | ||
| 47 | , # OPTIONAL | ||
| 48 | AuthorizationType => 'NONE', # OPTIONAL | ||
| 49 | AuthorizerId => 'MyId', # OPTIONAL | ||
| 50 | ModelSelectionExpression => 'MySelectionExpression', # OPTIONAL | ||
| 51 | OperationName => 'MyStringWithLengthBetween1And64', # OPTIONAL | ||
| 52 | RequestModels => { 'My__string' => 'MyStringWithLengthBetween1And128', } | ||
| 53 | , # OPTIONAL | ||
| 54 | RequestParameters => { 'My__string' => { Required => 1, }, }, # OPTIONAL | ||
| 55 | RouteResponseSelectionExpression => 'MySelectionExpression', # OPTIONAL | ||
| 56 | Target => 'MyStringWithLengthBetween1And128', # OPTIONAL | ||
| 57 | ); | ||
| 58 | |||
| 59 | # Results: | ||
| 60 | my $ApiGatewayManaged = $CreateRouteResponseShape->ApiGatewayManaged; | ||
| 61 | my $ApiKeyRequired = $CreateRouteResponseShape->ApiKeyRequired; | ||
| 62 | my $AuthorizationScopes = $CreateRouteResponseShape->AuthorizationScopes; | ||
| 63 | my $AuthorizationType = $CreateRouteResponseShape->AuthorizationType; | ||
| 64 | my $AuthorizerId = $CreateRouteResponseShape->AuthorizerId; | ||
| 65 | my $ModelSelectionExpression = | ||
| 66 | $CreateRouteResponseShape->ModelSelectionExpression; | ||
| 67 | my $OperationName = $CreateRouteResponseShape->OperationName; | ||
| 68 | my $RequestModels = $CreateRouteResponseShape->RequestModels; | ||
| 69 | my $RequestParameters = $CreateRouteResponseShape->RequestParameters; | ||
| 70 | my $RouteId = $CreateRouteResponseShape->RouteId; | ||
| 71 | my $RouteKey = $CreateRouteResponseShape->RouteKey; | ||
| 72 | my $RouteResponseSelectionExpression = | ||
| 73 | $CreateRouteResponseShape->RouteResponseSelectionExpression; | ||
| 74 | my $Target = $CreateRouteResponseShape->Target; | ||
| 75 | |||
| 76 | # Returns a L<Paws::ApiGatewayV2::CreateRouteResponseShape> object. | ||
| 77 | |||
| 78 | 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. | ||
| 79 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/apigateway/CreateRoute> | ||
| 80 | |||
| 81 | =head1 ATTRIBUTES | ||
| 82 | |||
| 83 | |||
| 84 | =head2 B<REQUIRED> ApiId => Str | ||
| 85 | |||
| 86 | The API identifier. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 ApiKeyRequired => Bool | ||
| 91 | |||
| 92 | Specifies whether an API key is required for the route. Supported only | ||
| 93 | for WebSocket APIs. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 AuthorizationScopes => ArrayRef[Str|Undef] | ||
| 98 | |||
| 99 | The authorization scopes supported by this route. | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head2 AuthorizationType => Str | ||
| 104 | |||
| 105 | The authorization type for the route. For WebSocket APIs, valid values | ||
| 106 | are NONE for open access, AWS_IAM for using AWS IAM permissions, and | ||
| 107 | CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are | ||
| 108 | NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using | ||
| 109 | AWS IAM permissions, and CUSTOM for using a Lambda authorizer. | ||
| 110 | |||
| 111 | Valid values are: C<"NONE">, C<"AWS_IAM">, C<"CUSTOM">, C<"JWT"> | ||
| 112 | |||
| 113 | =head2 AuthorizerId => Str | ||
| 114 | |||
| 115 | The identifier of the Authorizer resource to be associated with this | ||
| 116 | route. The authorizer identifier is generated by API Gateway when you | ||
| 117 | created the authorizer. | ||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | =head2 ModelSelectionExpression => Str | ||
| 122 | |||
| 123 | The model selection expression for the route. Supported only for | ||
| 124 | WebSocket APIs. | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head2 OperationName => Str | ||
| 129 | |||
| 130 | The operation name for the route. | ||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | =head2 RequestModels => L<Paws::ApiGatewayV2::RouteModels> | ||
| 135 | |||
| 136 | The request models for the route. Supported only for WebSocket APIs. | ||
| 137 | |||
| 138 | |||
| 139 | |||
| 140 | =head2 RequestParameters => L<Paws::ApiGatewayV2::RouteParameters> | ||
| 141 | |||
| 142 | The request parameters for the route. Supported only for WebSocket | ||
| 143 | APIs. | ||
| 144 | |||
| 145 | |||
| 146 | |||
| 147 | =head2 B<REQUIRED> RouteKey => Str | ||
| 148 | |||
| 149 | The route key for the route. | ||
| 150 | |||
| 151 | |||
| 152 | |||
| 153 | =head2 RouteResponseSelectionExpression => Str | ||
| 154 | |||
| 155 | The route response selection expression for the route. Supported only | ||
| 156 | for WebSocket APIs. | ||
| 157 | |||
| 158 | |||
| 159 | |||
| 160 | =head2 Target => Str | ||
| 161 | |||
| 162 | The target for the route. | ||
| 163 | |||
| 164 | |||
| 165 | |||
| 166 | |||
| 167 | =head1 SEE ALSO | ||
| 168 | |||
| 169 | This class forms part of L<Paws>, documenting arguments for method CreateRoute in L<Paws::ApiGatewayV2> | ||
| 170 | |||
| 171 | =head1 BUGS and CONTRIBUTIONS | ||
| 172 | |||
| 173 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 174 | |||
| 175 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 176 | |||
| 177 | =cut | ||
| 178 |