CreateRestApiRequest

public struct CreateRestApiRequest : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • The source of the API key for metering requests according to a usage plan. Valid values are: HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

    Declaration

    Swift

    public let apiKeySource: ApiKeySourceType?

  • The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

    Declaration

    Swift

    public let binaryMediaTypes: [String]?

  • The ID of the RestApi that you want to clone from.

    Declaration

    Swift

    public let cloneFrom: String?

  • The description of the RestApi.

    Declaration

    Swift

    public let description: String?

  • The endpoint configuration of this RestApi showing the endpoint types of the API.

    Declaration

    Swift

    public let endpointConfiguration: EndpointConfiguration?

  • A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

    Declaration

    Swift

    public let minimumCompressionSize: Int?

  • [Required] The name of the RestApi.

    Declaration

    Swift

    public let name: String

  • A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

    Declaration

    Swift

    public let policy: String?

  • The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

    Declaration

    Swift

    public let tags: [String : String]?

  • A version identifier for the API.

    Declaration

    Swift

    public let version: String?

  • Undocumented

    Declaration

    Swift

    public init(apiKeySource: ApiKeySourceType? = nil, binaryMediaTypes: [String]? = nil, cloneFrom: String? = nil, description: String? = nil, endpointConfiguration: EndpointConfiguration? = nil, minimumCompressionSize: Int? = nil, name: String, policy: String? = nil, tags: [String : String]? = nil, version: String? = nil)