You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ApiGatewayV2::Types::Api

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Represents an API.

Instance Attribute Summary collapse

Instance Attribute Details

#api_endpoint ⇒ String

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.

Returns:

  • (String) —

    The URI of the API, of the form `api-id.execute-api.region`.amazonaws.com.

#api_gateway_managed ⇒ Boolean

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.

Returns:

  • (Boolean) —

    Specifies whether an API is managed by API Gateway.

#api_id ⇒ String

The API ID.

Returns:

  • (String) —

    The API ID.

#api_key_selection_expression ⇒ String

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

Returns:

  • (String) —

    An API key selection expression.

#cors_configuration ⇒ Types::Cors

A CORS configuration. Supported only for HTTP APIs.

Returns:

#created_date ⇒ Time

The timestamp when the API was created.

Returns:

  • (Time) —

    The timestamp when the API was created.

#description ⇒ String

The description of the API.

Returns:

  • (String) —

    The description of the API.

#disable_execute_api_endpoint ⇒ 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" target="_parent" title="api_id">https://`{api_id</a>">api_id">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.

Returns:

  • (Boolean) —

    Specifies whether clients can invoke your API by using the default execute-api endpoint.

#disable_schema_validation ⇒ Boolean

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

Returns:

  • (Boolean) —

    Avoid validating models when creating a deployment.

#import_info ⇒ Array<String>

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.

Returns:

  • (Array<String>) —

    The validation information during API import.

#name ⇒ String

The name of the API.

Returns:

  • (String) —

    The name of the API.

#protocol_type ⇒ String

The API protocol.

Possible values:

  • WEBSOCKET
  • HTTP

Returns:

  • (String) —

    The API protocol.

#route_selection_expression ⇒ String

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be $`Aws::ApiGatewayV2::Types::Api.requestrequest.method` $`Aws::ApiGatewayV2::Types::Api.requestrequest.path`. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

Returns:

  • (String) —

    The route selection expression for the API.

#tags ⇒ Hash<String,String>

A collection of tags associated with the API.

Returns:

  • (Hash<String,String>) —

    A collection of tags associated with the API.

#version ⇒ String

A version identifier for the API.

Returns:

  • (String) —

    A version identifier for the API.

#warnings ⇒ Array<String>

The warning messages reported when failonwarnings is turned on during API import.

Returns:

  • (Array<String>) —

    The warning messages reported when failonwarnings is turned on during API import.