-ApiKeySelectionExpression <
String>
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Amazon.PowerShell.Cmdlets.AG2.AmazonApiGatewayV2ClientCmdlet.ClientConfig
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-CorsConfiguration_AllowCredential <
Boolean>
Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | CorsConfiguration_AllowCredentials |
-CorsConfiguration_AllowHeader <
String[]>
Represents a collection of allowed headers. Supported only for HTTP APIs.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | CorsConfiguration_AllowHeaders |
-CorsConfiguration_AllowMethod <
String[]>
Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | CorsConfiguration_AllowMethods |
-CorsConfiguration_AllowOrigin <
String[]>
Represents a collection of allowed origins. Supported only for HTTP APIs.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | CorsConfiguration_AllowOrigins |
-CorsConfiguration_ExposeHeader <
String[]>
Represents a collection of exposed headers. Supported only for HTTP APIs.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | CorsConfiguration_ExposeHeaders |
-CorsConfiguration_MaxAge <
Int32>
The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The description of the API.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-DisableExecuteApiEndpoint <
Boolean>
Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The name of the API.
Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The API protocol.
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-RouteSelectionExpression <
String>
The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.CreateApiResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.CreateApiResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The collection of tags. Each tag element is associated with a given resource.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Tags |
This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
A version identifier for the API.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |