Skip to main content

AWSAPIGatewayWebSocketAPI

No description

type AWSAPIGatewayWebSocketAPI {
  metadata: ResourceMetadata!
  name: String!
  routeSelectionExpression: String!
  endpoint: String!
  apiGatewayManaged: Boolean!
  id: String!
  apiKeySelectionExpression: String!
  createdAt: DateTime!
  description: String!
  disableExecuteApiEndpoint: Boolean!
  disableSchemaValidation: Boolean!
  tags: [AWSTag!]!
  version: String!
  warnings: [String!]!
  stages: [AWSAPIGatewayV2Stage!]!
  routes: [AWSAPIGatewayWebSocketAPIRoute!]!
  authorizers: [AWSAPIGatewayWebSocketAPIAuthorizer!]!
  integrations: [AWSAPIGatewayWebSocketAPIIntegration!]!
}

Fields

`AWSAPIGatewayWebSocketAPI.metadata` ● `ResourceMetadata!` non-null object

The metadata to identify this API in Shisho Cloud

`AWSAPIGatewayWebSocketAPI.name` ● `String!` non-null scalar

The name of the API

`AWSAPIGatewayWebSocketAPI.routeSelectionExpression` ● `String!` non-null scalar

The route selection expression for the API

`AWSAPIGatewayWebSocketAPI.endpoint` ● `String!` non-null scalar

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

`AWSAPIGatewayWebSocketAPI.apiGatewayManaged` ● `Boolean!` non-null scalar

Indicates whether an API is managed by API Gateway

`AWSAPIGatewayWebSocketAPI.id` ● `String!` non-null scalar

The API ID

`AWSAPIGatewayWebSocketAPI.apiKeySelectionExpression` ● `String!` non-null scalar

The API key selection expression for the API

`AWSAPIGatewayWebSocketAPI.createdAt` ● `DateTime!` non-null scalar

The timestamp when the API was created

`AWSAPIGatewayWebSocketAPI.description` ● `String!` non-null scalar

The description of the API

`AWSAPIGatewayWebSocketAPI.disableExecuteApiEndpoint` ● `Boolean!` non-null scalar

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

`AWSAPIGatewayWebSocketAPI.disableSchemaValidation` ● `Boolean!` non-null scalar

Avoid validating models when creating a deployment

`AWSAPIGatewayWebSocketAPI.tags` ● `[AWSTag!]!` non-null object

The collection of tags

`AWSAPIGatewayWebSocketAPI.version` ● `String!` non-null scalar

A version identifier for the API

`AWSAPIGatewayWebSocketAPI.warnings` ● `[String!]!` non-null scalar

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

`AWSAPIGatewayWebSocketAPI.stages` ● `[AWSAPIGatewayV2Stage!]!` non-null object

The stages of this WebSocket API

`AWSAPIGatewayWebSocketAPI.routes` ● `[AWSAPIGatewayWebSocketAPIRoute!]!` non-null object

The routes of this WebSocket API

`AWSAPIGatewayWebSocketAPI.authorizers` ● `[AWSAPIGatewayWebSocketAPIAuthorizer!]!` non-null object

The authorizers of this WebSocket API

`AWSAPIGatewayWebSocketAPI.integrations` ● `[AWSAPIGatewayWebSocketAPIIntegration!]!` non-null object

The integrations of this WebSocket API

Implemented by

AWSAPIGatewayAPI union

Fields
Implemented by