« blib/lib/Paws/ApiGatewayV2/CreateApi.pm
↑ Summary
blib/lib/Paws/ApiGatewayV2/CreateApiMapping.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ApiGatewayV2::CreateApiInput; | ||
| 3 | use Moose; | ||
| 4 | has ApiKeySelectionExpression => (is => 'ro', isa => 'Str', request_name => 'apiKeySelectionExpression', traits => ['NameInRequest']); | ||
| 5 | has CorsConfiguration => (is => 'ro', isa => 'Paws::ApiGatewayV2::Cors', request_name => 'corsConfiguration', traits => ['NameInRequest']); | ||
| 6 | has CredentialsArn => (is => 'ro', isa => 'Str', request_name => 'credentialsArn', traits => ['NameInRequest']); | ||
| 7 | has Description => (is => 'ro', isa => 'Str', request_name => 'description', traits => ['NameInRequest']); | ||
| 8 | has DisableExecuteApiEndpoint => (is => 'ro', isa => 'Bool', request_name => 'disableExecuteApiEndpoint', traits => ['NameInRequest']); | ||
| 9 | has DisableSchemaValidation => (is => 'ro', isa => 'Bool', request_name => 'disableSchemaValidation', traits => ['NameInRequest']); | ||
| 10 | has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest'], required => 1); | ||
| 11 | has ProtocolType => (is => 'ro', isa => 'Str', request_name => 'protocolType', traits => ['NameInRequest'], required => 1); | ||
| 12 | has RouteKey => (is => 'ro', isa => 'Str', request_name => 'routeKey', traits => ['NameInRequest']); | ||
| 13 | has RouteSelectionExpression => (is => 'ro', isa => 'Str', request_name => 'routeSelectionExpression', traits => ['NameInRequest']); | ||
| 14 | has Tags => (is => 'ro', isa => 'Paws::ApiGatewayV2::Tags', request_name => 'tags', traits => ['NameInRequest']); | ||
| 15 | has Target => (is => 'ro', isa => 'Str', request_name => 'target', traits => ['NameInRequest']); | ||
| 16 | has Version => (is => 'ro', isa => 'Str', request_name => 'version', traits => ['NameInRequest']); | ||
| 17 | |||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::ApiGatewayV2::CreateApiInput | ||
| 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::CreateApiInput object: | ||
| 36 | |||
| 37 | $service_obj->Method(Att1 => { ApiKeySelectionExpression => $value, ..., Version => $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::CreateApiInput object: | ||
| 42 | |||
| 43 | $result = $service_obj->Method(...); | ||
| 44 | $result->Att1->ApiKeySelectionExpression | ||
| 45 | |||
| 46 | =head1 DESCRIPTION | ||
| 47 | |||
| 48 | Represents the input parameters for a CreateApi request. | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 ApiKeySelectionExpression => Str | ||
| 54 | |||
| 55 | An API key selection expression. Supported only for WebSocket APIs. See | ||
| 56 | API Key Selection Expressions | ||
| 57 | (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). | ||
| 58 | |||
| 59 | |||
| 60 | =head2 CorsConfiguration => L<Paws::ApiGatewayV2::Cors> | ||
| 61 | |||
| 62 | A CORS configuration. Supported only for HTTP APIs. See Configuring | ||
| 63 | CORS | ||
| 64 | (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) | ||
| 65 | for more information. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 CredentialsArn => Str | ||
| 69 | |||
| 70 | This property is part of quick create. It specifies the credentials | ||
| 71 | required for the integration, if any. For a Lambda integration, three | ||
| 72 | options are available. To specify an IAM Role for API Gateway to | ||
| 73 | assume, use the role's Amazon Resource Name (ARN). To require that the | ||
| 74 | caller's identity be passed through from the request, specify | ||
| 75 | arn:aws:iam::*:user/*. To use resource-based permissions on supported | ||
| 76 | AWS services, specify null. Currently, this property is not used for | ||
| 77 | HTTP integrations. Supported only for HTTP APIs. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 Description => Str | ||
| 81 | |||
| 82 | The description of the API. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 DisableExecuteApiEndpoint => Bool | ||
| 86 | |||
| 87 | Specifies whether clients can invoke your API by using the default | ||
| 88 | execute-api endpoint. By default, clients can invoke your API with the | ||
| 89 | default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. | ||
| 90 | To require that clients use a custom domain name to invoke your API, | ||
| 91 | disable the default endpoint. | ||
| 92 | |||
| 93 | |||
| 94 | =head2 DisableSchemaValidation => Bool | ||
| 95 | |||
| 96 | Avoid validating models when creating a deployment. Supported only for | ||
| 97 | WebSocket APIs. | ||
| 98 | |||
| 99 | |||
| 100 | =head2 B<REQUIRED> Name => Str | ||
| 101 | |||
| 102 | The name of the API. | ||
| 103 | |||
| 104 | |||
| 105 | =head2 B<REQUIRED> ProtocolType => Str | ||
| 106 | |||
| 107 | The API protocol. | ||
| 108 | |||
| 109 | |||
| 110 | =head2 RouteKey => Str | ||
| 111 | |||
| 112 | This property is part of quick create. If you don't specify a routeKey, | ||
| 113 | a default route of $default is created. The $default route acts as a | ||
| 114 | catch-all for any request made to your API, for a particular stage. The | ||
| 115 | $default route key can't be modified. You can add routes after creating | ||
| 116 | the API, and you can update the route keys of additional routes. | ||
| 117 | Supported only for HTTP APIs. | ||
| 118 | |||
| 119 | |||
| 120 | =head2 RouteSelectionExpression => Str | ||
| 121 | |||
| 122 | The route selection expression for the API. For HTTP APIs, the | ||
| 123 | routeSelectionExpression must be ${request.method} ${request.path}. If | ||
| 124 | not provided, this will be the default for HTTP APIs. This property is | ||
| 125 | required for WebSocket APIs. | ||
| 126 | |||
| 127 | |||
| 128 | =head2 Tags => L<Paws::ApiGatewayV2::Tags> | ||
| 129 | |||
| 130 | The collection of tags. Each tag element is associated with a given | ||
| 131 | resource. | ||
| 132 | |||
| 133 | |||
| 134 | =head2 Target => Str | ||
| 135 | |||
| 136 | This property is part of quick create. Quick create produces an API | ||
| 137 | with an integration, a default catch-all route, and a default stage | ||
| 138 | which is configured to automatically deploy changes. For HTTP | ||
| 139 | integrations, specify a fully qualified URL. For Lambda integrations, | ||
| 140 | specify a function ARN. The type of the integration will be HTTP_PROXY | ||
| 141 | or AWS_PROXY, respectively. Supported only for HTTP APIs. | ||
| 142 | |||
| 143 | |||
| 144 | =head2 Version => Str | ||
| 145 | |||
| 146 | A version identifier for the API. | ||
| 147 | |||
| 148 | |||
| 149 | |||
| 150 | =head1 SEE ALSO | ||
| 151 | |||
| 152 | This class forms part of L<Paws>, describing an object used in L<Paws::ApiGatewayV2> | ||
| 153 | |||
| 154 | =head1 BUGS and CONTRIBUTIONS | ||
| 155 | |||
| 156 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 157 | |||
| 158 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 159 | |||
| 160 | =cut | ||
| 161 |