Class: Aws::ApiGatewayV2::Types::CreateApiRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::ApiGatewayV2::Types::CreateApiRequest
- Defined in:
- gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb
Overview
When making an API call, you may pass CreateApiRequest data as a 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",
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#api_key_selection_expression ⇒ String
An expression used to extract information at runtime.
-
#cors_configuration ⇒ Types::Cors
Represents a CORS configuration.
-
#credentials_arn ⇒ String
Represents an Amazon Resource Name (ARN).
-
#description ⇒ String
A string with a length between [0-1024].
-
#disable_execute_api_endpoint ⇒ Boolean
-
#disable_schema_validation ⇒ Boolean
-
#name ⇒ String
A string with a length between [1-128].
-
#protocol_type ⇒ 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.
-
#route_selection_expression ⇒ String
An expression used to extract information at runtime.
-
#tags ⇒ 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].
-
#version ⇒ String
A string with a length between [1-64].
Instance Attribute Details
#api_key_selection_expression ⇒ String
An expression used to extract information at runtime. See Selection Expressions for more information.
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 752 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 for more information.
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 752 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).
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 752 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].
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 752 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
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 752 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
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 752 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].
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 752 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.
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 752 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 for a list of expressions and each expression's associated selection key type.
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 752 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.
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 752 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.
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 752 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].
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 752 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].
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 752 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 |