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
show all
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

Instance Attribute Details

#cache_cluster_enabledBoolean

Specifies whether a cache cluster is enabled for the stage.

Returns:

  • (Boolean)

    Specifies whether a cache cluster is enabled for the stage.

#cache_cluster_sizeString

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

Returns:

  • (String)

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

#cache_cluster_statusString

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

Returns:

  • (String)

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

#client_certificate_idString

The identifier of a client certificate for an API stage.

Returns:

  • (String)

    The identifier of a client certificate for an API stage.

#created_dateTime

The timestamp when the stage was created.

Returns:

  • (Time)

    The timestamp when the stage was created.

#deployment_idString

The identifier of the Deployment that the stage points to.

Returns:

  • (String)

    The identifier of the Deployment that the stage points to.

#descriptionString

The stage\'s description.

Returns:

  • (String)

    The stage\'s description.

#documentation_versionString

The version of the associated API documentation.

Returns:

  • (String)

    The version of the associated API documentation.

#last_updated_dateTime

The timestamp when the stage last updated.

Returns:

  • (Time)

    The timestamp when the stage last updated.

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

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

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

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

    A map that defines the stage variables for a Stage resource.