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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-apigatewayv2/types.rb

Constant Summary collapse

SENSITIVE = 
[]

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.

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions

Returns:

  • (String) 


694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
 
# File 'lib/aws-sdk-apigatewayv2/types.rb', line 694

class CreateApiRequest < Struct.new(
  :api_key_selection_expression,
  :cors_configuration,
  :credentials_arn,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :name,
  :protocol_type,
  :route_key,
  :route_selection_expression,
  :tags,
  :target,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#cors_configuration ⇒ Types::Cors

Represents a CORS configuration. Supported only for HTTP APIs. See

Configuring CORS][1

for more information.

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html

Returns:



694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
 
# File 'lib/aws-sdk-apigatewayv2/types.rb', line 694

class CreateApiRequest < Struct.new(
  :api_key_selection_expression,
  :cors_configuration,
  :credentials_arn,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :name,
  :protocol_type,
  :route_key,
  :route_selection_expression,
  :tags,
  :target,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#credentials_arn ⇒ String

Represents an Amazon Resource Name (ARN).

Returns:

  • (String) 


694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
 
# File 'lib/aws-sdk-apigatewayv2/types.rb', line 694

class CreateApiRequest < Struct.new(
  :api_key_selection_expression,
  :cors_configuration,
  :credentials_arn,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :name,
  :protocol_type,
  :route_key,
  :route_selection_expression,
  :tags,
  :target,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

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

Returns:

  • (String) 


694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
 
# File 'lib/aws-sdk-apigatewayv2/types.rb', line 694

class CreateApiRequest < Struct.new(
  :api_key_selection_expression,
  :cors_configuration,
  :credentials_arn,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :name,
  :protocol_type,
  :route_key,
  :route_selection_expression,
  :tags,
  :target,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#disable_execute_api_endpoint ⇒ Boolean

Returns:

  • (Boolean) 


694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
 
# File 'lib/aws-sdk-apigatewayv2/types.rb', line 694

class CreateApiRequest < Struct.new(
  :api_key_selection_expression,
  :cors_configuration,
  :credentials_arn,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :name,
  :protocol_type,
  :route_key,
  :route_selection_expression,
  :tags,
  :target,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#disable_schema_validation ⇒ Boolean

Returns:

  • (Boolean) 


694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
 
# File 'lib/aws-sdk-apigatewayv2/types.rb', line 694

class CreateApiRequest < Struct.new(
  :api_key_selection_expression,
  :cors_configuration,
  :credentials_arn,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :name,
  :protocol_type,
  :route_key,
  :route_selection_expression,
  :tags,
  :target,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

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

Returns:

  • (String) 


694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
 
# File 'lib/aws-sdk-apigatewayv2/types.rb', line 694

class CreateApiRequest < Struct.new(
  :api_key_selection_expression,
  :cors_configuration,
  :credentials_arn,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :name,
  :protocol_type,
  :route_key,
  :route_selection_expression,
  :tags,
  :target,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#protocol_type ⇒ String

Represents a protocol type.

Returns:

  • (String) 


694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
 
# File 'lib/aws-sdk-apigatewayv2/types.rb', line 694

class CreateApiRequest < Struct.new(
  :api_key_selection_expression,
  :cors_configuration,
  :credentials_arn,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :name,
  :protocol_type,
  :route_key,
  :route_selection_expression,
  :tags,
  :target,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#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][1

for a list of expressions and each

expression’s associated selection key type.

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions

Returns:

  • (String) 


694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
 
# File 'lib/aws-sdk-apigatewayv2/types.rb', line 694

class CreateApiRequest < Struct.new(
  :api_key_selection_expression,
  :cors_configuration,
  :credentials_arn,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :name,
  :protocol_type,
  :route_key,
  :route_selection_expression,
  :tags,
  :target,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#route_selection_expression ⇒ String

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

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions

Returns:

  • (String) 


694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
 
# File 'lib/aws-sdk-apigatewayv2/types.rb', line 694

class CreateApiRequest < Struct.new(
  :api_key_selection_expression,
  :cors_configuration,
  :credentials_arn,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :name,
  :protocol_type,
  :route_key,
  :route_selection_expression,
  :tags,
  :target,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Represents a collection of tags associated with the resource.

Returns:

  • (Hash<String,String>) 


694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
 
# File 'lib/aws-sdk-apigatewayv2/types.rb', line 694

class CreateApiRequest < Struct.new(
  :api_key_selection_expression,
  :cors_configuration,
  :credentials_arn,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :name,
  :protocol_type,
  :route_key,
  :route_selection_expression,
  :tags,
  :target,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#target ⇒ String

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

Returns:

  • (String) 


694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
 
# File 'lib/aws-sdk-apigatewayv2/types.rb', line 694

class CreateApiRequest < Struct.new(
  :api_key_selection_expression,
  :cors_configuration,
  :credentials_arn,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :name,
  :protocol_type,
  :route_key,
  :route_selection_expression,
  :tags,
  :target,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ String

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

Returns:

  • (String) 


694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
 
# File 'lib/aws-sdk-apigatewayv2/types.rb', line 694

class CreateApiRequest < Struct.new(
  :api_key_selection_expression,
  :cors_configuration,
  :credentials_arn,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :name,
  :protocol_type,
  :route_key,
  :route_selection_expression,
  :tags,
  :target,
  :version)
  SENSITIVE = []
  include Aws::Structure
end