class Aws::ApiGatewayV2::Types::CreateApiInput

Represents the input parameters for a CreateApi request.

@!attribute [rw] api_key_selection_expression

An API key selection expression. Supported only for WebSocket APIs.
See [API Key Selection Expressions][1].

[1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
@return [String]

@!attribute [rw] cors_configuration

A CORS configuration. Supported only for HTTP APIs. See [Configuring
CORS][1] for more information.

[1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html
@return [Types::Cors]

@!attribute [rw] credentials_arn

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.
@return [String]

@!attribute [rw] description

The description of the API.
@return [String]

@!attribute [rw] disable_schema_validation

Avoid validating models when creating a deployment. Supported only
for WebSocket APIs.
@return [Boolean]

@!attribute [rw] disable_execute_api_endpoint

@return [Boolean]

@!attribute [rw] name

The name of the API.
@return [String]

@!attribute [rw] protocol_type

The API protocol.
@return [String]

@!attribute [rw] route_key

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.
@return [String]

@!attribute [rw] route_selection_expression

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.
@return [String]

@!attribute [rw] tags

The collection of tags. Each tag element is associated with a given
resource.
@return [Hash<String,String>]

@!attribute [rw] target

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.
@return [String]

@!attribute [rw] version

A version identifier for the API.
@return [String]

Constants

SENSITIVE