Class: Aws::ApiGatewayV2::Types::UpdateApiRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::ApiGatewayV2::Types::UpdateApiRequest
- Defined in:
- gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb
Overview
When making an API call, you may pass UpdateApiRequest data as a hash:
{
api_id: "__string", # required
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",
route_key: "SelectionKey",
route_selection_expression: "SelectionExpression",
target: "UriWithLengthBetween1And2048",
version: "StringWithLengthBetween1And64",
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#api_id ⇒ String
-
#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].
-
#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.
-
#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_id ⇒ String
6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6760 class UpdateApiRequest < Struct.new( :api_id, :api_key_selection_expression, :cors_configuration, :credentials_arn, :description, :disable_schema_validation, :disable_execute_api_endpoint, :name, :route_key, :route_selection_expression, :target, :version) SENSITIVE = [] include Aws::Structure end |
#api_key_selection_expression ⇒ String
An expression used to extract information at runtime. See Selection Expressions for more information.
6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6760 class UpdateApiRequest < Struct.new( :api_id, :api_key_selection_expression, :cors_configuration, :credentials_arn, :description, :disable_schema_validation, :disable_execute_api_endpoint, :name, :route_key, :route_selection_expression, :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.
6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6760 class UpdateApiRequest < Struct.new( :api_id, :api_key_selection_expression, :cors_configuration, :credentials_arn, :description, :disable_schema_validation, :disable_execute_api_endpoint, :name, :route_key, :route_selection_expression, :target, :version) SENSITIVE = [] include Aws::Structure end |
#credentials_arn ⇒ String
Represents an Amazon Resource Name (ARN).
6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6760 class UpdateApiRequest < Struct.new( :api_id, :api_key_selection_expression, :cors_configuration, :credentials_arn, :description, :disable_schema_validation, :disable_execute_api_endpoint, :name, :route_key, :route_selection_expression, :target, :version) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
A string with a length between [0-1024].
6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6760 class UpdateApiRequest < Struct.new( :api_id, :api_key_selection_expression, :cors_configuration, :credentials_arn, :description, :disable_schema_validation, :disable_execute_api_endpoint, :name, :route_key, :route_selection_expression, :target, :version) SENSITIVE = [] include Aws::Structure end |
#disable_execute_api_endpoint ⇒ Boolean
6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6760 class UpdateApiRequest < Struct.new( :api_id, :api_key_selection_expression, :cors_configuration, :credentials_arn, :description, :disable_schema_validation, :disable_execute_api_endpoint, :name, :route_key, :route_selection_expression, :target, :version) SENSITIVE = [] include Aws::Structure end |
#disable_schema_validation ⇒ Boolean
6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6760 class UpdateApiRequest < Struct.new( :api_id, :api_key_selection_expression, :cors_configuration, :credentials_arn, :description, :disable_schema_validation, :disable_execute_api_endpoint, :name, :route_key, :route_selection_expression, :target, :version) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
A string with a length between [1-128].
6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6760 class UpdateApiRequest < Struct.new( :api_id, :api_key_selection_expression, :cors_configuration, :credentials_arn, :description, :disable_schema_validation, :disable_execute_api_endpoint, :name, :route_key, :route_selection_expression, :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.
6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6760 class UpdateApiRequest < Struct.new( :api_id, :api_key_selection_expression, :cors_configuration, :credentials_arn, :description, :disable_schema_validation, :disable_execute_api_endpoint, :name, :route_key, :route_selection_expression, :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.
6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6760 class UpdateApiRequest < Struct.new( :api_id, :api_key_selection_expression, :cors_configuration, :credentials_arn, :description, :disable_schema_validation, :disable_execute_api_endpoint, :name, :route_key, :route_selection_expression, :target, :version) SENSITIVE = [] include Aws::Structure end |
#target ⇒ String
A string representation of a URI with a length between [1-2048].
6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6760 class UpdateApiRequest < Struct.new( :api_id, :api_key_selection_expression, :cors_configuration, :credentials_arn, :description, :disable_schema_validation, :disable_execute_api_endpoint, :name, :route_key, :route_selection_expression, :target, :version) SENSITIVE = [] include Aws::Structure end |
#version ⇒ String
A string with a length between [1-64].
6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6760 class UpdateApiRequest < Struct.new( :api_id, :api_key_selection_expression, :cors_configuration, :credentials_arn, :description, :disable_schema_validation, :disable_execute_api_endpoint, :name, :route_key, :route_selection_expression, :target, :version) SENSITIVE = [] include Aws::Structure end |