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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb

Overview

Represents an API.

Constant Summary collapse

SENSITIVE =
[]

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)


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 137

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,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#api_gateway_managedBoolean

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)


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 137

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,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#api_idString

The API ID.

Returns:

  • (String)


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 137

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,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#api_key_selection_expressionString

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

Returns:

  • (String)


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 137

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,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#cors_configurationTypes::Cors

A CORS configuration. Supported only for HTTP APIs.

Returns:



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 137

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,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#created_dateTime

The timestamp when the API was created.

Returns:

  • (Time)


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 137

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,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description of the API.

Returns:

  • (String)


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 137

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,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#disable_execute_api_endpointBoolean

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)


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 137

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,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#disable_schema_validationBoolean

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

Returns:

  • (Boolean)


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 137

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,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

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


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 137

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,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the API.

Returns:

  • (String)


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 137

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,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#protocol_typeString

The API protocol.

Returns:

  • (String)


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 137

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,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#route_selection_expressionString

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.

Returns:

  • (String)


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 137

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,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

A collection of tags associated with the API.

Returns:

  • (Hash<String,String>)


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 137

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,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#versionString

A version identifier for the API.

Returns:

  • (String)


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 137

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,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#warningsArray<String>

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

Returns:

  • (Array<String>)


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 137

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,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end