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

Class: Aws::ApiGatewayV2::Types::CreateApiInput

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

Overview

Represents the input parameters for a CreateApi request.

Instance Attribute Summary collapse

Instance Attribute Details

#api_key_selection_expressionString

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

Returns:

  • (String)

    An API key selection expression.

#cors_configurationTypes::Cors

A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.

Returns:

#credentials_arnString

This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role\'s Amazon Resource Name (ARN). To require that the caller\'s identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.

Returns:

  • (String)

    This property is part of quick create.

#descriptionString

The description of the API.

Returns:

  • (String)

    The description of the API.

#disable_schema_validationBoolean

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

Returns:

  • (Boolean)

    Avoid validating models when creating a deployment.

#nameString

The name of the API.

Returns:

  • (String)

    The name of the API.

#protocol_typeString

The API protocol.

Possible values:

  • WEBSOCKET
  • HTTP

Returns:

  • (String)

    The API protocol.

#route_keyString

This property is part of quick create. If you don\'t specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can\'t be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.

Returns:

  • (String)

    This property is part of quick create.

#route_selection_expressionString

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be $`Aws::ApiGatewayV2::Types::CreateApiInput.requestrequest.method` $`Aws::ApiGatewayV2::Types::CreateApiInput.requestrequest.path`. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

Returns:

  • (String)

    The route selection expression for the API.

#tagsHash<String,String>

The collection of tags. Each tag element is associated with a given resource.

Returns:

  • (Hash<String,String>)

    The collection of tags.

#targetString

This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.

Returns:

  • (String)

    This property is part of quick create.

#versionString

A version identifier for the API.

Returns:

  • (String)

    A version identifier for the API.