AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::ApiGatewayV2::Types::UpdateStageInput

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

Overview

Represents the input parameters for an UpdateStage request.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access_log_settingsTypes::AccessLogSettings

Settings for logging access in this stage.



8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 8713

class UpdateStageInput < Struct.new(
  :access_log_settings,
  :auto_deploy,
  :client_certificate_id,
  :default_route_settings,
  :deployment_id,
  :description,
  :route_settings,
  :stage_variables)
  SENSITIVE = []
  include Aws::Structure
end

#auto_deployBoolean

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

Returns:

  • (Boolean)


8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 8713

class UpdateStageInput < Struct.new(
  :access_log_settings,
  :auto_deploy,
  :client_certificate_id,
  :default_route_settings,
  :deployment_id,
  :description,
  :route_settings,
  :stage_variables)
  SENSITIVE = []
  include Aws::Structure
end

#client_certificate_idString

The identifier of a client certificate for a Stage.

Returns:

  • (String)


8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 8713

class UpdateStageInput < Struct.new(
  :access_log_settings,
  :auto_deploy,
  :client_certificate_id,
  :default_route_settings,
  :deployment_id,
  :description,
  :route_settings,
  :stage_variables)
  SENSITIVE = []
  include Aws::Structure
end

#default_route_settingsTypes::RouteSettings

The default route settings for the stage.



8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 8713

class UpdateStageInput < Struct.new(
  :access_log_settings,
  :auto_deploy,
  :client_certificate_id,
  :default_route_settings,
  :deployment_id,
  :description,
  :route_settings,
  :stage_variables)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_idString

The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.

Returns:

  • (String)


8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 8713

class UpdateStageInput < Struct.new(
  :access_log_settings,
  :auto_deploy,
  :client_certificate_id,
  :default_route_settings,
  :deployment_id,
  :description,
  :route_settings,
  :stage_variables)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description for the API stage.

Returns:

  • (String)


8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 8713

class UpdateStageInput < Struct.new(
  :access_log_settings,
  :auto_deploy,
  :client_certificate_id,
  :default_route_settings,
  :deployment_id,
  :description,
  :route_settings,
  :stage_variables)
  SENSITIVE = []
  include Aws::Structure
end

#route_settingsHash<String,Types::RouteSettings>

Route settings for the stage.

Returns:



8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 8713

class UpdateStageInput < Struct.new(
  :access_log_settings,
  :auto_deploy,
  :client_certificate_id,
  :default_route_settings,
  :deployment_id,
  :description,
  :route_settings,
  :stage_variables)
  SENSITIVE = []
  include Aws::Structure
end

#stage_variablesHash<String,String>

A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Returns:

  • (Hash<String,String>)


8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 8713

class UpdateStageInput < Struct.new(
  :access_log_settings,
  :auto_deploy,
  :client_certificate_id,
  :default_route_settings,
  :deployment_id,
  :description,
  :route_settings,
  :stage_variables)
  SENSITIVE = []
  include Aws::Structure
end