apigateway/aws.sdk.kotlin.services.apigateway.model/Stage

Stage

class Stage

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

Types

object Companion

Properties

accessLogSettings

val accessLogSettings: AccessLogSettings?

Settings for logging access in this stage.

cacheClusterEnabled

val cacheClusterEnabled: Boolean

Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set CachingEnabled to true for a method.

cacheClusterSize

val cacheClusterSize: CacheClusterSize?

The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.

cacheClusterStatus

val cacheClusterStatus: CacheClusterStatus?

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

val canarySettings: CanarySettings?

Settings for the canary deployment in this stage.

clientCertificateId

val clientCertificateId: String?

The identifier of a client certificate for an API stage.

val createdDate: Instant?

The timestamp when the stage was created.

val deploymentId: String?

The identifier of the Deployment that the stage points to.

val description: String?

The stage's description.

documentationVersion

val documentationVersion: String?

The version of the associated API documentation.

lastUpdatedDate

val lastUpdatedDate: Instant?

The timestamp when the stage last updated.

val methodSettings: Map<String, 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.

val stageName: 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.

val tags: Map<String, String>?

The collection of tags. Each tag element is associated with a given resource.

val tracingEnabled: Boolean

Specifies whether active tracing with X-ray is enabled for the Stage.

val variables: Map<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-._~:/?#&=,]+.

val webAclArn: String?

The ARN of the WebAcl associated with the Stage.

Functions

inline fun copy(block: Stage.Builder.() -> Unit = {}): Stage

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String