« blib/lib/Paws/ApiGatewayV2/AccessLogSettings.pm
↑ Summary
blib/lib/Paws/ApiGatewayV2/ApiMapping.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ApiGatewayV2::Api; | ||
| 3 | use Moose; | ||
| 4 | has ApiEndpoint => (is => 'ro', isa => 'Str', request_name => 'apiEndpoint', traits => ['NameInRequest']); | ||
| 5 | has ApiGatewayManaged => (is => 'ro', isa => 'Bool', request_name => 'apiGatewayManaged', traits => ['NameInRequest']); | ||
| 6 | has ApiId => (is => 'ro', isa => 'Str', request_name => 'apiId', traits => ['NameInRequest']); | ||
| 7 | has ApiKeySelectionExpression => (is => 'ro', isa => 'Str', request_name => 'apiKeySelectionExpression', traits => ['NameInRequest']); | ||
| 8 | has CorsConfiguration => (is => 'ro', isa => 'Paws::ApiGatewayV2::Cors', request_name => 'corsConfiguration', traits => ['NameInRequest']); | ||
| 9 | has CreatedDate => (is => 'ro', isa => 'Str', request_name => 'createdDate', traits => ['NameInRequest']); | ||
| 10 | has Description => (is => 'ro', isa => 'Str', request_name => 'description', traits => ['NameInRequest']); | ||
| 11 | has DisableExecuteApiEndpoint => (is => 'ro', isa => 'Bool', request_name => 'disableExecuteApiEndpoint', traits => ['NameInRequest']); | ||
| 12 | has DisableSchemaValidation => (is => 'ro', isa => 'Bool', request_name => 'disableSchemaValidation', traits => ['NameInRequest']); | ||
| 13 | has ImportInfo => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'importInfo', traits => ['NameInRequest']); | ||
| 14 | has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest'], required => 1); | ||
| 15 | has ProtocolType => (is => 'ro', isa => 'Str', request_name => 'protocolType', traits => ['NameInRequest'], required => 1); | ||
| 16 | has RouteSelectionExpression => (is => 'ro', isa => 'Str', request_name => 'routeSelectionExpression', traits => ['NameInRequest'], required => 1); | ||
| 17 | has Tags => (is => 'ro', isa => 'Paws::ApiGatewayV2::Tags', request_name => 'tags', traits => ['NameInRequest']); | ||
| 18 | has Version => (is => 'ro', isa => 'Str', request_name => 'version', traits => ['NameInRequest']); | ||
| 19 | has Warnings => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'warnings', traits => ['NameInRequest']); | ||
| 20 | |||
| 21 | 1; | ||
| 22 | |||
| 23 | ### main pod documentation begin ### | ||
| 24 | |||
| 25 | =head1 NAME | ||
| 26 | |||
| 27 | Paws::ApiGatewayV2::Api | ||
| 28 | |||
| 29 | =head1 USAGE | ||
| 30 | |||
| 31 | This class represents one of two things: | ||
| 32 | |||
| 33 | =head3 Arguments in a call to a service | ||
| 34 | |||
| 35 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 36 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 37 | |||
| 38 | As an example, if Att1 is expected to be a Paws::ApiGatewayV2::Api object: | ||
| 39 | |||
| 40 | $service_obj->Method(Att1 => { ApiEndpoint => $value, ..., Warnings => $value }); | ||
| 41 | |||
| 42 | =head3 Results returned from an API call | ||
| 43 | |||
| 44 | Use accessors for each attribute. If Att1 is expected to be an Paws::ApiGatewayV2::Api object: | ||
| 45 | |||
| 46 | $result = $service_obj->Method(...); | ||
| 47 | $result->Att1->ApiEndpoint | ||
| 48 | |||
| 49 | =head1 DESCRIPTION | ||
| 50 | |||
| 51 | Represents an API. | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 ApiEndpoint => Str | ||
| 57 | |||
| 58 | The URI of the API, of the form | ||
| 59 | {api-id}.execute-api.{region}.amazonaws.com. The stage name is | ||
| 60 | typically appended to this URI to form a complete path to a deployed | ||
| 61 | API stage. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 ApiGatewayManaged => Bool | ||
| 65 | |||
| 66 | Specifies whether an API is managed by API Gateway. You can't update or | ||
| 67 | delete a managed API by using API Gateway. A managed API can be deleted | ||
| 68 | only through the tooling or service that created it. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 ApiId => Str | ||
| 72 | |||
| 73 | The API ID. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 ApiKeySelectionExpression => Str | ||
| 77 | |||
| 78 | An API key selection expression. Supported only for WebSocket APIs. See | ||
| 79 | API Key Selection Expressions | ||
| 80 | (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). | ||
| 81 | |||
| 82 | |||
| 83 | =head2 CorsConfiguration => L<Paws::ApiGatewayV2::Cors> | ||
| 84 | |||
| 85 | A CORS configuration. Supported only for HTTP APIs. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 CreatedDate => Str | ||
| 89 | |||
| 90 | The timestamp when the API was created. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 Description => Str | ||
| 94 | |||
| 95 | The description of the API. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 DisableExecuteApiEndpoint => Bool | ||
| 99 | |||
| 100 | Specifies whether clients can invoke your API by using the default | ||
| 101 | execute-api endpoint. By default, clients can invoke your API with the | ||
| 102 | default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. | ||
| 103 | To require that clients use a custom domain name to invoke your API, | ||
| 104 | disable the default endpoint. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 DisableSchemaValidation => Bool | ||
| 108 | |||
| 109 | Avoid validating models when creating a deployment. Supported only for | ||
| 110 | WebSocket APIs. | ||
| 111 | |||
| 112 | |||
| 113 | =head2 ImportInfo => ArrayRef[Str|Undef] | ||
| 114 | |||
| 115 | The validation information during API import. This may include | ||
| 116 | particular properties of your OpenAPI definition which are ignored | ||
| 117 | during import. Supported only for HTTP APIs. | ||
| 118 | |||
| 119 | |||
| 120 | =head2 B<REQUIRED> Name => Str | ||
| 121 | |||
| 122 | The name of the API. | ||
| 123 | |||
| 124 | |||
| 125 | =head2 B<REQUIRED> ProtocolType => Str | ||
| 126 | |||
| 127 | The API protocol. | ||
| 128 | |||
| 129 | |||
| 130 | =head2 B<REQUIRED> RouteSelectionExpression => Str | ||
| 131 | |||
| 132 | The route selection expression for the API. For HTTP APIs, the | ||
| 133 | routeSelectionExpression must be ${request.method} ${request.path}. If | ||
| 134 | not provided, this will be the default for HTTP APIs. This property is | ||
| 135 | required for WebSocket APIs. | ||
| 136 | |||
| 137 | |||
| 138 | =head2 Tags => L<Paws::ApiGatewayV2::Tags> | ||
| 139 | |||
| 140 | A collection of tags associated with the API. | ||
| 141 | |||
| 142 | |||
| 143 | =head2 Version => Str | ||
| 144 | |||
| 145 | A version identifier for the API. | ||
| 146 | |||
| 147 | |||
| 148 | =head2 Warnings => ArrayRef[Str|Undef] | ||
| 149 | |||
| 150 | The warning messages reported when failonwarnings is turned on during | ||
| 151 | API import. | ||
| 152 | |||
| 153 | |||
| 154 | |||
| 155 | =head1 SEE ALSO | ||
| 156 | |||
| 157 | This class forms part of L<Paws>, describing an object used in L<Paws::ApiGatewayV2> | ||
| 158 | |||
| 159 | =head1 BUGS and CONTRIBUTIONS | ||
| 160 | |||
| 161 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 162 | |||
| 163 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 164 | |||
| 165 | =cut | ||
| 166 |