Stage¶
Structure Class¶
dataclass
¶
Represents a unique identifier for a version of a deployed RestApi that is callable by users.
Attributes¶
class-attribute
instance-attribute
¶
access_log_settings: AccessLogSettings | None = None
Settings for logging access in this stage.
class-attribute
instance-attribute
¶
cache_cluster_enabled: bool = False
Specifies whether a cache cluster is enabled for the stage. To activate
a method-level cache, set CachingEnabled to true for a method.
class-attribute
instance-attribute
¶
cache_cluster_size: CacheClusterSize | None = None
The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
class-attribute
instance-attribute
¶
cache_cluster_status: CacheClusterStatus | None = None
The status of the cache cluster for the stage, if enabled.
class-attribute
instance-attribute
¶
canary_settings: CanarySettings | None = None
Settings for the canary deployment in this stage.
class-attribute
instance-attribute
¶
client_certificate_id: str | None = None
The identifier of a client certificate for an API stage.
class-attribute
instance-attribute
¶
created_date: datetime | None = None
The timestamp when the stage was created.
class-attribute
instance-attribute
¶
deployment_id: str | None = None
The identifier of the Deployment that the stage points to.
class-attribute
instance-attribute
¶
description: str | None = None
The stage's description.
class-attribute
instance-attribute
¶
documentation_version: str | None = None
The version of the associated API documentation.
class-attribute
instance-attribute
¶
last_updated_date: datetime | None = None
The timestamp when the stage last updated.
class-attribute
instance-attribute
¶
method_settings: dict[str, MethodSetting] | None = None
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.
class-attribute
instance-attribute
¶
stage_name: str | None = None
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.
class-attribute
instance-attribute
¶
tags: dict[str, str] | None = None
The collection of tags. Each tag element is associated with a given resource.
class-attribute
instance-attribute
¶
tracing_enabled: bool = False
Specifies whether active tracing with X-ray is enabled for the Stage.
class-attribute
instance-attribute
¶
variables: dict[str, str] | None = None
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-._~:/?#&=,]+.
class-attribute
instance-attribute
¶
web_acl_arn: str | None = None
The ARN of the WebAcl associated with the Stage.