You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::APIGateway::Types::CreateRestApiRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateRestApiRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "String", # required
  description: "String",
  version: "String",
  clone_from: "String",
  binary_media_types: ["String"],
  endpoint_configuration: {
    types: ["REGIONAL"], # accepts REGIONAL, EDGE
  },
}

The POST Request to add a new RestApi resource to your collection.

Instance Attribute Summary collapse

Instance Attribute Details

#binary_media_typesArray<String>

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

Returns:

  • (Array<String>)

    The list of binary media types supported by the RestApi.

#clone_fromString

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

Returns:

  • (String)

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

#descriptionString

The description of the RestApi.

Returns:

  • (String)

    The description of the RestApi.

#endpoint_configurationTypes::EndpointConfiguration

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

Returns:

#nameString

The name of the RestApi.

Returns:

  • (String)

    The name of the RestApi.

#versionString

A version identifier for the API.

Returns:

  • (String)

    A version identifier for the API.