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

Inherits:

Struct

• Object
• Struct
• Aws::ApiGatewayV2::Types::Api

Includes:

Structure

Defined in:

lib/aws-sdk-apigatewayv2/types.rb

Overview

Represents an API.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #api_endpoint ⇒ 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.

• #api_id ⇒ String

  The API ID.

• #api_key_selection_expression ⇒ String

  An API key selection expression.

• #cors_configuration ⇒ Types::Cors

  A CORS configuration.

• #created_date ⇒ Time

  The timestamp when the API was created.

• #description ⇒ 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.

• #disable_schema_validation ⇒ Boolean

  Avoid validating models when creating a deployment.

• #import_info ⇒ Array<String>

  The validation information during API import.

• #ip_address_type ⇒ String

  The IP address types that can invoke the API.

• #name ⇒ String

  The name of the API.

• #protocol_type ⇒ String

  The API protocol.

• #route_selection_expression ⇒ String

  The route selection expression for the API.

• #tags ⇒ Hash<String,String>

  A collection of tags associated with the API.

• #version ⇒ String

  A version identifier for the API.

• #warnings ⇒ Array<String>

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

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)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 161

class Api < Struct.new(
  :api_endpoint,
  :api_gateway_managed,
  :api_id,
  :api_key_selection_expression,
  :cors_configuration,
  :created_date,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :import_info,
  :ip_address_type,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 161

class Api < Struct.new(
  :api_endpoint,
  :api_gateway_managed,
  :api_id,
  :api_key_selection_expression,
  :cors_configuration,
  :created_date,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :import_info,
  :ip_address_type,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#api_id ⇒ String

The API ID.

Returns:

• (String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 161

class Api < Struct.new(
  :api_endpoint,
  :api_gateway_managed,
  :api_id,
  :api_key_selection_expression,
  :cors_configuration,
  :created_date,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :import_info,
  :ip_address_type,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#api_key_selection_expression ⇒ String

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

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

Returns:

• (String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 161

class Api < Struct.new(
  :api_endpoint,
  :api_gateway_managed,
  :api_id,
  :api_key_selection_expression,
  :cors_configuration,
  :created_date,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :import_info,
  :ip_address_type,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#cors_configuration ⇒ Types::Cors

A CORS configuration. Supported only for HTTP APIs.

Returns:

• (Types::Cors)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 161

class Api < Struct.new(
  :api_endpoint,
  :api_gateway_managed,
  :api_id,
  :api_key_selection_expression,
  :cors_configuration,
  :created_date,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :import_info,
  :ip_address_type,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#created_date ⇒ Time

The timestamp when the API was created.

Returns:

• (Time)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 161

class Api < Struct.new(
  :api_endpoint,
  :api_gateway_managed,
  :api_id,
  :api_key_selection_expression,
  :cors_configuration,
  :created_date,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :import_info,
  :ip_address_type,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the API.

Returns:

• (String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 161

class Api < Struct.new(
  :api_endpoint,
  :api_gateway_managed,
  :api_id,
  :api_key_selection_expression,
  :cors_configuration,
  :created_date,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :import_info,
  :ip_address_type,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 161

class Api < Struct.new(
  :api_endpoint,
  :api_gateway_managed,
  :api_id,
  :api_key_selection_expression,
  :cors_configuration,
  :created_date,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :import_info,
  :ip_address_type,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#disable_schema_validation ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 161

class Api < Struct.new(
  :api_endpoint,
  :api_gateway_managed,
  :api_id,
  :api_key_selection_expression,
  :cors_configuration,
  :created_date,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :import_info,
  :ip_address_type,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#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>)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 161

class Api < Struct.new(
  :api_endpoint,
  :api_gateway_managed,
  :api_id,
  :api_key_selection_expression,
  :cors_configuration,
  :created_date,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :import_info,
  :ip_address_type,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#ip_address_type ⇒ String

The IP address types that can invoke the API.

Returns:

• (String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 161

class Api < Struct.new(
  :api_endpoint,
  :api_gateway_managed,
  :api_id,
  :api_key_selection_expression,
  :cors_configuration,
  :created_date,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :import_info,
  :ip_address_type,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the API.

Returns:

• (String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 161

class Api < Struct.new(
  :api_endpoint,
  :api_gateway_managed,
  :api_id,
  :api_key_selection_expression,
  :cors_configuration,
  :created_date,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :import_info,
  :ip_address_type,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#protocol_type ⇒ String

The API protocol.

Returns:

• (String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 161

class Api < Struct.new(
  :api_endpoint,
  :api_gateway_managed,
  :api_id,
  :api_key_selection_expression,
  :cors_configuration,
  :created_date,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :import_info,
  :ip_address_type,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 161

class Api < Struct.new(
  :api_endpoint,
  :api_gateway_managed,
  :api_id,
  :api_key_selection_expression,
  :cors_configuration,
  :created_date,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :import_info,
  :ip_address_type,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A collection of tags associated with the API.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 161

class Api < Struct.new(
  :api_endpoint,
  :api_gateway_managed,
  :api_id,
  :api_key_selection_expression,
  :cors_configuration,
  :created_date,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :import_info,
  :ip_address_type,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ String

A version identifier for the API.

Returns:

• (String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 161

class Api < Struct.new(
  :api_endpoint,
  :api_gateway_managed,
  :api_id,
  :api_key_selection_expression,
  :cors_configuration,
  :created_date,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :import_info,
  :ip_address_type,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#warnings ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 161

class Api < Struct.new(
  :api_endpoint,
  :api_gateway_managed,
  :api_id,
  :api_key_selection_expression,
  :cors_configuration,
  :created_date,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :import_info,
  :ip_address_type,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end