Api

public struct Api : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • 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.

    Declaration

    Swift

    public let apiEndpoint: String?

  • 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.

    Declaration

    Swift

    public let apiGatewayManaged: Bool?

  • The API ID.

    Declaration

    Swift

    public let apiId: String?

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

    Declaration

    Swift

    public let apiKeySelectionExpression: String?

  • A CORS configuration. Supported only for HTTP APIs.

    Declaration

    Swift

    public let corsConfiguration: Cors?

  • The timestamp when the API was created.

    Declaration

    Swift

    public let createdDate: TimeStamp?

  • The description of the API.

    Declaration

    Swift

    public let description: String?

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

    Declaration

    Swift

    public let disableSchemaValidation: Bool?

  • 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.

    Declaration

    Swift

    public let importInfo: [String]?

  • The name of the API.

    Declaration

    Swift

    public let name: String

  • The API protocol.

    Declaration

    Swift

    public let protocolType: ProtocolType

  • 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.

    Declaration

    Swift

    public let routeSelectionExpression: String

  • A collection of tags associated with the API.

    Declaration

    Swift

    public let tags: [String : String]?

  • A version identifier for the API.

    Declaration

    Swift

    public let version: String?

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

    Declaration

    Swift

    public let warnings: [String]?

  • Undocumented

    Declaration

    Swift

    public init(apiEndpoint: String? = nil, apiGatewayManaged: Bool? = nil, apiId: String? = nil, apiKeySelectionExpression: String? = nil, corsConfiguration: Cors? = nil, createdDate: TimeStamp? = nil, description: String? = nil, disableSchemaValidation: Bool? = nil, importInfo: [String]? = nil, name: String, protocolType: ProtocolType, routeSelectionExpression: String, tags: [String : String]? = nil, version: String? = nil, warnings: [String]? = nil)