« blib/lib/Paws/ApiGatewayV2/UpdateApi.pm
↑ Summary
blib/lib/Paws/ApiGatewayV2/UpdateApiMapping.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ApiGatewayV2::UpdateApiInput; | ||
| 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']); | ||
| 11 | has RouteKey => (is => 'ro', isa => 'Str', request_name => 'routeKey', traits => ['NameInRequest']); | ||
| 12 | has RouteSelectionExpression => (is => 'ro', isa => 'Str', request_name => 'routeSelectionExpression', traits => ['NameInRequest']); | ||
| 13 | has Target => (is => 'ro', isa => 'Str', request_name => 'target', traits => ['NameInRequest']); | ||
| 14 | has Version => (is => 'ro', isa => 'Str', request_name => 'version', traits => ['NameInRequest']); | ||
| 15 | |||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::ApiGatewayV2::UpdateApiInput | ||
| 23 | |||
| 24 | =head1 USAGE | ||
| 25 | |||
| 26 | This class represents one of two things: | ||
| 27 | |||
| 28 | =head3 Arguments in a call to a service | ||
| 29 | |||
| 30 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 31 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 32 | |||
| 33 | As an example, if Att1 is expected to be a Paws::ApiGatewayV2::UpdateApiInput object: | ||
| 34 | |||
| 35 | $service_obj->Method(Att1 => { ApiKeySelectionExpression => $value, ..., Version => $value }); | ||
| 36 | |||
| 37 | =head3 Results returned from an API call | ||
| 38 | |||
| 39 | Use accessors for each attribute. If Att1 is expected to be an Paws::ApiGatewayV2::UpdateApiInput object: | ||
| 40 | |||
| 41 | $result = $service_obj->Method(...); | ||
| 42 | $result->Att1->ApiKeySelectionExpression | ||
| 43 | |||
| 44 | =head1 DESCRIPTION | ||
| 45 | |||
| 46 | Represents the input parameters for an UpdateApi request. | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 ApiKeySelectionExpression => Str | ||
| 52 | |||
| 53 | An API key selection expression. Supported only for WebSocket APIs. See | ||
| 54 | API Key Selection Expressions | ||
| 55 | (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). | ||
| 56 | |||
| 57 | |||
| 58 | =head2 CorsConfiguration => L<Paws::ApiGatewayV2::Cors> | ||
| 59 | |||
| 60 | A CORS configuration. Supported only for HTTP APIs. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 CredentialsArn => Str | ||
| 64 | |||
| 65 | This property is part of quick create. It specifies the credentials | ||
| 66 | required for the integration, if any. For a Lambda integration, three | ||
| 67 | options are available. To specify an IAM Role for API Gateway to | ||
| 68 | assume, use the role's Amazon Resource Name (ARN). To require that the | ||
| 69 | caller's identity be passed through from the request, specify | ||
| 70 | arn:aws:iam::*:user/*. To use resource-based permissions on supported | ||
| 71 | AWS services, specify null. Currently, this property is not used for | ||
| 72 | HTTP integrations. If provided, this value replaces the credentials | ||
| 73 | associated with the quick create integration. Supported only for HTTP | ||
| 74 | APIs. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 Description => Str | ||
| 78 | |||
| 79 | The description of the API. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 DisableExecuteApiEndpoint => Bool | ||
| 83 | |||
| 84 | Specifies whether clients can invoke your API by using the default | ||
| 85 | execute-api endpoint. By default, clients can invoke your API with the | ||
| 86 | default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. | ||
| 87 | To require that clients use a custom domain name to invoke your API, | ||
| 88 | disable the default endpoint. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 DisableSchemaValidation => Bool | ||
| 92 | |||
| 93 | Avoid validating models when creating a deployment. Supported only for | ||
| 94 | WebSocket APIs. | ||
| 95 | |||
| 96 | |||
| 97 | =head2 Name => Str | ||
| 98 | |||
| 99 | The name of the API. | ||
| 100 | |||
| 101 | |||
| 102 | =head2 RouteKey => Str | ||
| 103 | |||
| 104 | This property is part of quick create. If not specified, the route | ||
| 105 | created using quick create is kept. Otherwise, this value replaces the | ||
| 106 | route key of the quick create route. Additional routes may still be | ||
| 107 | added after the API is updated. Supported only for HTTP APIs. | ||
| 108 | |||
| 109 | |||
| 110 | =head2 RouteSelectionExpression => Str | ||
| 111 | |||
| 112 | The route selection expression for the API. For HTTP APIs, the | ||
| 113 | routeSelectionExpression must be ${request.method} ${request.path}. If | ||
| 114 | not provided, this will be the default for HTTP APIs. This property is | ||
| 115 | required for WebSocket APIs. | ||
| 116 | |||
| 117 | |||
| 118 | =head2 Target => Str | ||
| 119 | |||
| 120 | This property is part of quick create. For HTTP integrations, specify a | ||
| 121 | fully qualified URL. For Lambda integrations, specify a function ARN. | ||
| 122 | The type of the integration will be HTTP_PROXY or AWS_PROXY, | ||
| 123 | respectively. The value provided updates the integration URI and | ||
| 124 | integration type. You can update a quick-created target, but you can't | ||
| 125 | remove it from an API. Supported only for HTTP APIs. | ||
| 126 | |||
| 127 | |||
| 128 | =head2 Version => Str | ||
| 129 | |||
| 130 | A version identifier for the API. | ||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | =head1 SEE ALSO | ||
| 135 | |||
| 136 | This class forms part of L<Paws>, describing an object used in L<Paws::ApiGatewayV2> | ||
| 137 | |||
| 138 | =head1 BUGS and CONTRIBUTIONS | ||
| 139 | |||
| 140 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 141 | |||
| 142 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 143 | |||
| 144 | =cut | ||
| 145 |