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

Class: Aws::APIGateway::Types::Stage

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

Overview

Represents a unique identifier for a version of a deployed RestApi that is callable by users.

[Deploy an API][1]

Instance Attribute Summary collapse

Instance Attribute Details

#cache_cluster_enabledBoolean

Specifies whether a cache cluster is enabled for the stage.

Returns:

  • (Boolean)


5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5467

class Stage < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :created_date,
  :last_updated_date)
  include Aws::Structure
end

#cache_cluster_sizeString

The size of the cache cluster for the stage, if enabled.

Returns:

  • (String)


5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5467

class Stage < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :created_date,
  :last_updated_date)
  include Aws::Structure
end

#cache_cluster_statusString

The status of the cache cluster for the stage, if enabled.

Returns:

  • (String)


5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5467

class Stage < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :created_date,
  :last_updated_date)
  include Aws::Structure
end

#client_certificate_idString

The identifier of a client certificate for an API stage.

Returns:

  • (String)


5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5467

class Stage < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :created_date,
  :last_updated_date)
  include Aws::Structure
end

#created_dateTime

The timestamp when the stage was created.

Returns:

  • (Time)


5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5467

class Stage < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :created_date,
  :last_updated_date)
  include Aws::Structure
end

#deployment_idString

The identifier of the Deployment that the stage points to.

Returns:

  • (String)


5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5467

class Stage < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :created_date,
  :last_updated_date)
  include Aws::Structure
end

#descriptionString

The stage's description.

Returns:

  • (String)


5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5467

class Stage < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :created_date,
  :last_updated_date)
  include Aws::Structure
end

#documentation_versionString

The version of the associated API documentation.

Returns:

  • (String)


5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5467

class Stage < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :created_date,
  :last_updated_date)
  include Aws::Structure
end

#last_updated_dateTime

The timestamp when the stage last updated.

Returns:

  • (Time)


5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5467

class Stage < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :created_date,
  :last_updated_date)
  include Aws::Structure
end

#method_settingsHash<String,Types::MethodSetting>

A map that defines the method settings for a Stage resource. Keys (designated as /\{method_setting_key below) are method paths defined as \{resource_path\}/\{http_method\} for an individual method override, or /*/* for overriding all methods in the stage.

Returns:



5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5467

class Stage < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :created_date,
  :last_updated_date)
  include Aws::Structure
end

#stage_nameString

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to Amazon API Gateway.

Returns:

  • (String)


5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5467

class Stage < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :created_date,
  :last_updated_date)
  include Aws::Structure
end

#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>)


5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5467

class Stage < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :created_date,
  :last_updated_date)
  include Aws::Structure
end