You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ApiGatewayV2::Types::Stage

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

Overview

Represents an API stage.

Instance Attribute Summary collapse

Instance Attribute Details

#access_log_settingsTypes::AccessLogSettings

Settings for logging access in this stage.



4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4498

class Stage < Struct.new(
  :access_log_settings,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  include Aws::Structure
end

#client_certificate_idString

The identifier of a client certificate for a Stage.

Returns:

  • (String)


4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4498

class Stage < Struct.new(
  :access_log_settings,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  include Aws::Structure
end

#created_dateTime

The timestamp when the stage was created.

Returns:

  • (Time)


4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4498

class Stage < Struct.new(
  :access_log_settings,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  include Aws::Structure
end

#default_route_settingsTypes::RouteSettings

Default route settings for the stage.



4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4498

class Stage < Struct.new(
  :access_log_settings,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  include Aws::Structure
end

#deployment_idString

The identifier of the Deployment that the Stage is associated with.

Returns:

  • (String)


4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4498

class Stage < Struct.new(
  :access_log_settings,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  include Aws::Structure
end

#descriptionString

The description of the stage.

Returns:

  • (String)


4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4498

class Stage < Struct.new(
  :access_log_settings,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  include Aws::Structure
end

#last_updated_dateTime

The timestamp when the stage was last updated.

Returns:

  • (Time)


4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4498

class Stage < Struct.new(
  :access_log_settings,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  include Aws::Structure
end

#route_settingsHash<String,Types::RouteSettings>

Route settings for the stage.

Returns:



4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4498

class Stage < Struct.new(
  :access_log_settings,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  include Aws::Structure
end

#stage_nameString

The name of the stage.

Returns:

  • (String)


4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4498

class Stage < Struct.new(
  :access_log_settings,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  include Aws::Structure
end

#stage_variablesHash<String,String>

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

Returns:

  • (Hash<String,String>)


4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4498

class Stage < Struct.new(
  :access_log_settings,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  include Aws::Structure
end

#tagsHash<String,String>

Tags for the Stage.

Returns:

  • (Hash<String,String>)


4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4498

class Stage < Struct.new(
  :access_log_settings,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  include Aws::Structure
end