Class: Aws::ApiGatewayV2::Types::UpdateApiInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::ApiGatewayV2::Types::UpdateApiInput
- Defined in:
- gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb
Overview
Represents the input parameters for an UpdateApi request.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#api_key_selection_expression ⇒ String
An API key selection expression.
-
#cors_configuration ⇒ Types::Cors
A CORS configuration.
-
#credentials_arn ⇒ String
This property is part of quick create.
-
#description ⇒ String
The description of the API.
-
#disable_execute_api_endpoint ⇒ Boolean
-
#disable_schema_validation ⇒ Boolean
Avoid validating models when creating a deployment.
-
#name ⇒ String
The name of the API.
-
#route_key ⇒ String
This property is part of quick create.
-
#route_selection_expression ⇒ String
The route selection expression for the API.
-
#target ⇒ String
This property is part of quick create.
-
#version ⇒ String
A version identifier for the API.
Instance Attribute Details
#api_key_selection_expression ⇒ String
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5824 class UpdateApiInput < Struct.new( :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
A CORS configuration. Supported only for HTTP APIs.
5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5824 class UpdateApiInput < Struct.new( :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
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. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.
5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5824 class UpdateApiInput < Struct.new( :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
The description of the API.
5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5824 class UpdateApiInput < Struct.new( :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
5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5824 class UpdateApiInput < Struct.new( :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
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5824 class UpdateApiInput < Struct.new( :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
The name of the API.
5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5824 class UpdateApiInput < Struct.new( :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
This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.
5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5824 class UpdateApiInput < Struct.new( :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
The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method\} ${request.path\}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5824 class UpdateApiInput < Struct.new( :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
This property is part of quick create. 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. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.
5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5824 class UpdateApiInput < Struct.new( :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 version identifier for the API.
5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5824 class UpdateApiInput < Struct.new( :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 |