class Aws::ApiGatewayV2::Types::Api

Represents an API.

@!attribute [rw] api_endpoint

The URI of the API, of the form
\\\{api-id\\}.execute-api.\\\{region\\}.amazonaws.com. The stage
name is typically appended to this URI to form a complete path to a
deployed API stage.
@return [String]

@!attribute [rw] api_gateway_managed

Specifies whether an API is managed by API Gateway. You can't
update or delete a managed API by using API Gateway. A managed API
can be deleted only through the tooling or service that created it.
@return [Boolean]

@!attribute [rw] api_id

The API ID.
@return [String]

@!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.
@return [Types::Cors]

@!attribute [rw] created_date

The timestamp when the API was created.
@return [Time]

@!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

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

@!attribute [rw] import_info

The validation information during API import. This may include
particular properties of your OpenAPI definition which are ignored
during import. Supported only for HTTP APIs.
@return [Array<String>]

@!attribute [rw] name

The name of the API.
@return [String]

@!attribute [rw] protocol_type

The API protocol.
@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

A collection of tags associated with the API.
@return [Hash<String,String>]

@!attribute [rw] version

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

@!attribute [rw] warnings

The warning messages reported when failonwarnings is turned on
during API import.
@return [Array<String>]

Constants

SENSITIVE