Class: Aws::ApiGatewayV2::Types::UpdateStageRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::ApiGatewayV2::Types::UpdateStageRequest
- Defined in:
- gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb
Overview
Note:
When making an API call, you may pass UpdateStageRequest data as a hash:
{
access_log_settings: {
destination_arn: "Arn",
format: "StringWithLengthBetween1And1024",
},
api_id: "__string", # required
auto_deploy: false,
client_certificate_id: "Id",
default_route_settings: {
data_trace_enabled: false,
detailed_metrics_enabled: false,
logging_level: "ERROR", # accepts ERROR, INFO, OFF
throttling_burst_limit: 1,
throttling_rate_limit: 1.0,
},
deployment_id: "Id",
description: "StringWithLengthBetween0And1024",
route_settings: {
"__string" => {
data_trace_enabled: false,
detailed_metrics_enabled: false,
logging_level: "ERROR", # accepts ERROR, INFO, OFF
throttling_burst_limit: 1,
throttling_rate_limit: 1.0,
},
},
stage_name: "__string", # required
stage_variables: {
"__string" => "StringWithLengthBetween0And2048",
},
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#access_log_settings ⇒ Types::AccessLogSettings
Settings for logging access in a stage.
-
#api_id ⇒ String
-
#auto_deploy ⇒ Boolean
-
#client_certificate_id ⇒ String
The identifier.
-
#default_route_settings ⇒ Types::RouteSettings
Represents a collection of route settings.
-
#deployment_id ⇒ String
The identifier.
-
#description ⇒ String
A string with a length between [0-1024].
-
#route_settings ⇒ Hash<String,Types::RouteSettings>
The route settings map.
-
#stage_name ⇒ String
-
#stage_variables ⇒ Hash<String,String>
The stage variable map.
Instance Attribute Details
#access_log_settings ⇒ Types::AccessLogSettings
Settings for logging access in a stage.
8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 8798 class UpdateStageRequest < Struct.new( :access_log_settings, :api_id, :auto_deploy, :client_certificate_id, :default_route_settings, :deployment_id, :description, :route_settings, :stage_name, :stage_variables) SENSITIVE = [] include Aws::Structure end |
#api_id ⇒ String
8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 8798 class UpdateStageRequest < Struct.new( :access_log_settings, :api_id, :auto_deploy, :client_certificate_id, :default_route_settings, :deployment_id, :description, :route_settings, :stage_name, :stage_variables) SENSITIVE = [] include Aws::Structure end |
#auto_deploy ⇒ Boolean
8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 8798 class UpdateStageRequest < Struct.new( :access_log_settings, :api_id, :auto_deploy, :client_certificate_id, :default_route_settings, :deployment_id, :description, :route_settings, :stage_name, :stage_variables) SENSITIVE = [] include Aws::Structure end |
#client_certificate_id ⇒ String
The identifier.
8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 8798 class UpdateStageRequest < Struct.new( :access_log_settings, :api_id, :auto_deploy, :client_certificate_id, :default_route_settings, :deployment_id, :description, :route_settings, :stage_name, :stage_variables) SENSITIVE = [] include Aws::Structure end |
#default_route_settings ⇒ Types::RouteSettings
Represents a collection of route settings.
8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 8798 class UpdateStageRequest < Struct.new( :access_log_settings, :api_id, :auto_deploy, :client_certificate_id, :default_route_settings, :deployment_id, :description, :route_settings, :stage_name, :stage_variables) SENSITIVE = [] include Aws::Structure end |
#deployment_id ⇒ String
The identifier.
8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 8798 class UpdateStageRequest < Struct.new( :access_log_settings, :api_id, :auto_deploy, :client_certificate_id, :default_route_settings, :deployment_id, :description, :route_settings, :stage_name, :stage_variables) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
A string with a length between [0-1024].
8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 8798 class UpdateStageRequest < Struct.new( :access_log_settings, :api_id, :auto_deploy, :client_certificate_id, :default_route_settings, :deployment_id, :description, :route_settings, :stage_name, :stage_variables) SENSITIVE = [] include Aws::Structure end |
#route_settings ⇒ Hash<String,Types::RouteSettings>
The route settings map.
8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 8798 class UpdateStageRequest < Struct.new( :access_log_settings, :api_id, :auto_deploy, :client_certificate_id, :default_route_settings, :deployment_id, :description, :route_settings, :stage_name, :stage_variables) SENSITIVE = [] include Aws::Structure end |
#stage_name ⇒ String
8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 8798 class UpdateStageRequest < Struct.new( :access_log_settings, :api_id, :auto_deploy, :client_certificate_id, :default_route_settings, :deployment_id, :description, :route_settings, :stage_name, :stage_variables) SENSITIVE = [] include Aws::Structure end |
#stage_variables ⇒ Hash<String,String>
The stage variable map.
8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 8798 class UpdateStageRequest < Struct.new( :access_log_settings, :api_id, :auto_deploy, :client_certificate_id, :default_route_settings, :deployment_id, :description, :route_settings, :stage_name, :stage_variables) SENSITIVE = [] include Aws::Structure end |