You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::APIGateway::Types::Stage
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::Stage
- Defined in:
- (unknown)
Overview
Represents a unique identifier for a version of a deployed RestApi that is callable by users.
Returned by:
Instance Attribute Summary collapse
-
#access_log_settings ⇒ Types::AccessLogSettings
Settings for logging access in this stage.
-
#cache_cluster_enabled ⇒ Boolean
Specifies whether a cache cluster is enabled for the stage.
-
#cache_cluster_size ⇒ String
The size of the cache cluster for the stage, if enabled.
-
#cache_cluster_status ⇒ String
The status of the cache cluster for the stage, if enabled.
-
#canary_settings ⇒ Types::CanarySettings
Settings for the canary deployment in this stage.
-
#client_certificate_id ⇒ String
The identifier of a client certificate for an API stage.
-
#created_date ⇒ Time
The timestamp when the stage was created.
-
#deployment_id ⇒ String
The identifier of the Deployment that the stage points to.
-
#description ⇒ String
The stage\'s description.
-
#documentation_version ⇒ String
The version of the associated API documentation.
-
#last_updated_date ⇒ Time
The timestamp when the stage last updated.
-
#method_settings ⇒ Hash<String,Types::MethodSetting>
A map that defines the method settings for a Stage resource.
-
#stage_name ⇒ String
The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway.
-
#tags ⇒ Hash<String,String>
The collection of tags.
-
#tracing_enabled ⇒ Boolean
Specifies whether active tracing with X-ray is enabled for the Stage.
-
#variables ⇒ Hash<String,String>
A map that defines the stage variables for a Stage resource.
-
#web_acl_arn ⇒ String
The ARN of the WebAcl associated with the Stage.
Instance Attribute Details
#access_log_settings ⇒ Types::AccessLogSettings
Settings for logging access in this stage.
#cache_cluster_enabled ⇒ Boolean
Specifies whether a cache cluster is enabled for the stage.
#cache_cluster_size ⇒ String
The size of the cache cluster for the stage, if enabled.
Possible values:
- 0.5
- 1.6
- 6.1
- 13.5
- 28.4
- 58.2
- 118
- 237
#cache_cluster_status ⇒ String
The status of the cache cluster for the stage, if enabled.
Possible values:
- CREATE_IN_PROGRESS
- AVAILABLE
- DELETE_IN_PROGRESS
- NOT_AVAILABLE
- FLUSH_IN_PROGRESS
#canary_settings ⇒ Types::CanarySettings
Settings for the canary deployment in this stage.
#client_certificate_id ⇒ String
The identifier of a client certificate for an API stage.
#created_date ⇒ Time
The timestamp when the stage was created.
#deployment_id ⇒ String
The identifier of the Deployment that the stage points to.
#description ⇒ String
The stage\'s description.
#documentation_version ⇒ String
The version of the associated API documentation.
#last_updated_date ⇒ Time
The timestamp when the stage last updated.
#method_settings ⇒ Hash<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.
#stage_name ⇒ String
The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
#tags ⇒ Hash<String,String>
The collection of tags. Each tag element is associated with a given resource.
#tracing_enabled ⇒ Boolean
Specifies whether active tracing with X-ray is enabled for the Stage.
#variables ⇒ Hash<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-._~:/?#&=,]+
.
#web_acl_arn ⇒ String
The ARN of the WebAcl associated with the Stage.