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_endpointString

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_idString

The API ID.

Returns:

  • (String)

    The API ID.

#api_key_selection_expressionString

An API key selection expression. See API Key Selection Expressions.

Returns:

  • (String)

    An API key selection expression.

#created_dateTime

The timestamp when the API was created.

Returns:

  • (Time)

    The timestamp when the API was created.

#descriptionString

The description of the API.

Returns:

  • (String)

    The description of the API.

#disable_schema_validationBoolean

Avoid validating models when creating a deployment.

Returns:

  • (Boolean)

    Avoid validating models when creating a deployment.

#nameString

The name of the API.

Returns:

  • (String)

    The name of the API.

#protocol_typeString

The API protocol: Currently only WEBSOCKET is supported.

Possible values:

  • WEBSOCKET

Returns:

  • (String)

    The API protocol: Currently only WEBSOCKET is supported.

#route_selection_expressionString

The route selection expression for the API.

Returns:

  • (String)

    The route selection expression for the API.

#tagsHash<String,String>

Tags for the API.

Returns:

  • (Hash<String,String>)

    Tags for the API.

#versionString

A version identifier for the API.

Returns:

  • (String)

    A version identifier for the API.

#warningsArray<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.