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

Class: Aws::ApiGatewayV2::Types::CreateApiRequest

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

Overview

Note:

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

{
  api_key_selection_expression: "SelectionExpression",
  cors_configuration: {
    allow_credentials: false,
    allow_headers: ["__string"],
    allow_methods: ["StringWithLengthBetween1And64"],
    allow_origins: ["__string"],
    expose_headers: ["__string"],
    max_age: 1,
  },
  credentials_arn: "Arn",
  description: "StringWithLengthBetween0And1024",
  disable_schema_validation: false,
  disable_execute_api_endpoint: false,
  name: "StringWithLengthBetween1And128", # required
  protocol_type: "WEBSOCKET", # required, accepts WEBSOCKET, HTTP
  route_key: "SelectionKey",
  route_selection_expression: "SelectionExpression",
  tags: {
    "__string" => "StringWithLengthBetween1And1600",
  },
  target: "UriWithLengthBetween1And2048",
  version: "StringWithLengthBetween1And64",
}

Instance Attribute Summary collapse

Instance Attribute Details

#api_key_selection_expression ⇒ String

An expression used to extract information at runtime. See Selection Expressions for more information.

Returns:

  • (String) —

    An expression used to extract information at runtime.

#cors_configuration ⇒ Types::Cors

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

Returns:

#credentials_arn ⇒ String

Represents an Amazon Resource Name (ARN).

Returns:

  • (String) —

    Represents an Amazon Resource Name (ARN).

    .

#description ⇒ String

A string with a length between [0-1024].

Returns:

  • (String) —

    A string with a length between [0-1024].

    .

#disable_execute_api_endpoint ⇒ Boolean

Returns:

  • (Boolean)

#disable_schema_validation ⇒ Boolean

Returns:

  • (Boolean)

#name ⇒ String

A string with a length between [1-128].

Returns:

  • (String) —

    A string with a length between [1-128].

    .

#protocol_type ⇒ String

Represents a protocol type.

Possible values:

  • WEBSOCKET
  • HTTP

Returns:

  • (String) —

    Represents a protocol type.

#route_key ⇒ String

After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See Selection Expressions for a list of expressions and each expression's associated selection key type.

Returns:

  • (String) —

    After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key.

#route_selection_expression ⇒ String

An expression used to extract information at runtime. See Selection Expressions for more information.

Returns:

  • (String) —

    An expression used to extract information at runtime.

#tags ⇒ Hash<String,String>

Represents a collection of tags associated with the resource.

Returns:

  • (Hash<String,String>) —

    Represents a collection of tags associated with the resource.

    .

#target ⇒ String

A string representation of a URI with a length between [1-2048].

Returns:

  • (String) —

    A string representation of a URI with a length between [1-2048].

    .

#version ⇒ String

A string with a length between [1-64].

Returns:

  • (String) —

    A string with a length between [1-64].

    .