| 1 | |||
| 2 | package Paws::ApiGateway::RestApi; | ||
| 3 | use Moose; | ||
| 4 | has ApiKeySource => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'apiKeySource'); | ||
| 5 | has BinaryMediaTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'binaryMediaTypes'); | ||
| 6 | has CreatedDate => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'createdDate'); | ||
| 7 | has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description'); | ||
| 8 | has DisableExecuteApiEndpoint => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'disableExecuteApiEndpoint'); | ||
| 9 | has EndpointConfiguration => (is => 'ro', isa => 'Paws::ApiGateway::EndpointConfiguration', traits => ['NameInRequest'], request_name => 'endpointConfiguration'); | ||
| 10 | has Id => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'id'); | ||
| 11 | has MinimumCompressionSize => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'minimumCompressionSize'); | ||
| 12 | has Name => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'name'); | ||
| 13 | has Policy => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'policy'); | ||
| 14 | has Tags => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToString', traits => ['NameInRequest'], request_name => 'tags'); | ||
| 15 | has Version => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'version'); | ||
| 16 | has Warnings => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'warnings'); | ||
| 17 | |||
| 18 | has _request_id => (is => 'ro', isa => 'Str'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::ApiGateway::RestApi | ||
| 26 | |||
| 27 | =head1 ATTRIBUTES | ||
| 28 | |||
| 29 | |||
| 30 | =head2 ApiKeySource => Str | ||
| 31 | |||
| 32 | The source of the API key for metering requests according to a usage | ||
| 33 | plan. Valid values are: | ||
| 34 | |||
| 35 | =over | ||
| 36 | |||
| 37 | =item * C<HEADER> to read the API key from the C<X-API-Key> header of a | ||
| 38 | request. | ||
| 39 | |||
| 40 | =item * C<AUTHORIZER> to read the API key from the | ||
| 41 | C<UsageIdentifierKey> from a custom authorizer. | ||
| 42 | |||
| 43 | =back | ||
| 44 | |||
| 45 | |||
| 46 | Valid values are: C<"HEADER">, C<"AUTHORIZER"> | ||
| 47 | =head2 BinaryMediaTypes => ArrayRef[Str|Undef] | ||
| 48 | |||
| 49 | The list of binary media types supported by the RestApi. By default, | ||
| 50 | the RestApi supports only UTF-8-encoded text payloads. | ||
| 51 | |||
| 52 | |||
| 53 | =head2 CreatedDate => Str | ||
| 54 | |||
| 55 | The timestamp when the API was created. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 Description => Str | ||
| 59 | |||
| 60 | The API's description. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 DisableExecuteApiEndpoint => Bool | ||
| 64 | |||
| 65 | Specifies whether clients can invoke your API by using the default | ||
| 66 | C<execute-api> endpoint. By default, clients can invoke your API with | ||
| 67 | the default https://{api_id}.execute-api.{region}.amazonaws.com | ||
| 68 | endpoint. To require that clients use a custom domain name to invoke | ||
| 69 | your API, disable the default endpoint. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 EndpointConfiguration => L<Paws::ApiGateway::EndpointConfiguration> | ||
| 73 | |||
| 74 | The endpoint configuration of this RestApi showing the endpoint types | ||
| 75 | of the API. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 Id => Str | ||
| 79 | |||
| 80 | The API's identifier. This identifier is unique across all of your APIs | ||
| 81 | in API Gateway. | ||
| 82 | |||
| 83 | |||
| 84 | =head2 MinimumCompressionSize => Int | ||
| 85 | |||
| 86 | A nullable integer that is used to enable compression (with | ||
| 87 | non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable | ||
| 88 | compression (with a null value) on an API. When compression is enabled, | ||
| 89 | compression or decompression is not applied on the payload if the | ||
| 90 | payload size is smaller than this value. Setting it to zero allows | ||
| 91 | compression for any payload size. | ||
| 92 | |||
| 93 | |||
| 94 | =head2 Name => Str | ||
| 95 | |||
| 96 | The API's name. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 Policy => Str | ||
| 100 | |||
| 101 | A stringified JSON policy document that applies to this RestApi | ||
| 102 | regardless of the caller and Method configuration. | ||
| 103 | |||
| 104 | |||
| 105 | =head2 Tags => L<Paws::ApiGateway::MapOfStringToString> | ||
| 106 | |||
| 107 | The collection of tags. Each tag element is associated with a given | ||
| 108 | resource. | ||
| 109 | |||
| 110 | |||
| 111 | =head2 Version => Str | ||
| 112 | |||
| 113 | A version identifier for the API. | ||
| 114 | |||
| 115 | |||
| 116 | =head2 Warnings => ArrayRef[Str|Undef] | ||
| 117 | |||
| 118 | The warning messages reported when C<failonwarnings> is turned on | ||
| 119 | during API import. | ||
| 120 | |||
| 121 | |||
| 122 | =head2 _request_id => Str | ||
| 123 | |||
| 124 | |||
| 125 | =cut | ||
| 126 |