class Aws::APIGateway::Types::Stage
Represents a unique identifier for a version of a deployed RestApi
that is callable by users.
<div class=“seeAlso” markdown=“1”>
- Deploy an API][1
-
</div>
[1]: docs.aws.amazon.com/apigateway/latest/developerguide/how-to-deploy-api.html
@!attribute [rw] deployment_id
The identifier of the Deployment that the stage points to. @return [String]
@!attribute [rw] client_certificate_id
The identifier of a client certificate for an API stage. @return [String]
@!attribute [rw] stage_name
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. @return [String]
@!attribute [rw] description
The stage's description. @return [String]
@!attribute [rw] cache_cluster_enabled
Specifies whether a cache cluster is enabled for the stage. @return [Boolean]
@!attribute [rw] cache_cluster_size
The size of the cache cluster for the stage, if enabled. @return [String]
@!attribute [rw] cache_cluster_status
The status of the cache cluster for the stage, if enabled. @return [String]
@!attribute [rw] method_settings
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. @return [Hash<String,Types::MethodSetting>]
@!attribute [rw] variables
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-._~:/?#&=,]+`. @return [Hash<String,String>]
@!attribute [rw] documentation_version
The version of the associated API documentation. @return [String]
@!attribute [rw] access_log_settings
Settings for logging access in this stage. @return [Types::AccessLogSettings]
@!attribute [rw] canary_settings
Settings for the canary deployment in this stage. @return [Types::CanarySettings]
@!attribute [rw] tracing_enabled
Specifies whether active tracing with X-ray is enabled for the Stage. @return [Boolean]
@!attribute [rw] web_acl_arn
The ARN of the WebAcl associated with the Stage. @return [String]
@!attribute [rw] tags
The collection of tags. Each tag element is associated with a given resource. @return [Hash<String,String>]
@!attribute [rw] created_date
The timestamp when the stage was created. @return [Time]
@!attribute [rw] last_updated_date
The timestamp when the stage last updated. @return [Time]
Constants
- SENSITIVE