Class: Aws::APIGateway::Types::Stage

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::Stage

Includes:

Structure

Defined in:

lib/aws-sdk-apigateway/types.rb

Overview

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

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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 stage’s cache capacity in GB.

• #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.

Returns:

• (Types::AccessLogSettings)

# File 'lib/aws-sdk-apigateway/types.rb', line 5009

class Stage < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :access_log_settings,
  :canary_settings,
  :tracing_enabled,
  :web_acl_arn,
  :tags,
  :created_date,
  :last_updated_date)
  SENSITIVE = []
  include Aws::Structure
end

#cache_cluster_enabled ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-apigateway/types.rb', line 5009

class Stage < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :access_log_settings,
  :canary_settings,
  :tracing_enabled,
  :web_acl_arn,
  :tags,
  :created_date,
  :last_updated_date)
  SENSITIVE = []
  include Aws::Structure
end

#cache_cluster_size ⇒ String

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

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 5009

class Stage < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :access_log_settings,
  :canary_settings,
  :tracing_enabled,
  :web_acl_arn,
  :tags,
  :created_date,
  :last_updated_date)
  SENSITIVE = []
  include Aws::Structure
end

#cache_cluster_status ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 5009

class Stage < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :access_log_settings,
  :canary_settings,
  :tracing_enabled,
  :web_acl_arn,
  :tags,
  :created_date,
  :last_updated_date)
  SENSITIVE = []
  include Aws::Structure
end

#canary_settings ⇒ Types::CanarySettings

Settings for the canary deployment in this stage.

Returns:

• (Types::CanarySettings)

# File 'lib/aws-sdk-apigateway/types.rb', line 5009

class Stage < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :access_log_settings,
  :canary_settings,
  :tracing_enabled,
  :web_acl_arn,
  :tags,
  :created_date,
  :last_updated_date)
  SENSITIVE = []
  include Aws::Structure
end

#client_certificate_id ⇒ String

The identifier of a client certificate for an API stage.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 5009

class Stage < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :access_log_settings,
  :canary_settings,
  :tracing_enabled,
  :web_acl_arn,
  :tags,
  :created_date,
  :last_updated_date)
  SENSITIVE = []
  include Aws::Structure
end

#created_date ⇒ Time

The timestamp when the stage was created.

Returns:

• (Time)

# File 'lib/aws-sdk-apigateway/types.rb', line 5009

class Stage < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :access_log_settings,
  :canary_settings,
  :tracing_enabled,
  :web_acl_arn,
  :tags,
  :created_date,
  :last_updated_date)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_id ⇒ String

The identifier of the Deployment that the stage points to.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 5009

class Stage < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :access_log_settings,
  :canary_settings,
  :tracing_enabled,
  :web_acl_arn,
  :tags,
  :created_date,
  :last_updated_date)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The stage’s description.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 5009

class Stage < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :access_log_settings,
  :canary_settings,
  :tracing_enabled,
  :web_acl_arn,
  :tags,
  :created_date,
  :last_updated_date)
  SENSITIVE = []
  include Aws::Structure
end

#documentation_version ⇒ String

The version of the associated API documentation.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 5009

class Stage < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :access_log_settings,
  :canary_settings,
  :tracing_enabled,
  :web_acl_arn,
  :tags,
  :created_date,
  :last_updated_date)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_date ⇒ Time

The timestamp when the stage last updated.

Returns:

• (Time)

# File 'lib/aws-sdk-apigateway/types.rb', line 5009

class Stage < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :access_log_settings,
  :canary_settings,
  :tracing_enabled,
  :web_acl_arn,
  :tags,
  :created_date,
  :last_updated_date)
  SENSITIVE = []
  include Aws::Structure
end

#method_settings ⇒ Hash<String,Types::MethodSetting>

A map that defines the method settings for a Stage resource. Keys (designated as ‘/below) are method paths defined as `{resource_path/http_method` for an individual method override, or `//` for overriding all methods in the stage.

Returns:

• (Hash<String,Types::MethodSetting>)

# File 'lib/aws-sdk-apigateway/types.rb', line 5009

class Stage < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :access_log_settings,
  :canary_settings,
  :tracing_enabled,
  :web_acl_arn,
  :tags,
  :created_date,
  :last_updated_date)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 5009

class Stage < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :access_log_settings,
  :canary_settings,
  :tracing_enabled,
  :web_acl_arn,
  :tags,
  :created_date,
  :last_updated_date)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-apigateway/types.rb', line 5009

class Stage < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :access_log_settings,
  :canary_settings,
  :tracing_enabled,
  :web_acl_arn,
  :tags,
  :created_date,
  :last_updated_date)
  SENSITIVE = []
  include Aws::Structure
end

#tracing_enabled ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-apigateway/types.rb', line 5009

class Stage < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :access_log_settings,
  :canary_settings,
  :tracing_enabled,
  :web_acl_arn,
  :tags,
  :created_date,
  :last_updated_date)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-apigateway/types.rb', line 5009

class Stage < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :access_log_settings,
  :canary_settings,
  :tracing_enabled,
  :web_acl_arn,
  :tags,
  :created_date,
  :last_updated_date)
  SENSITIVE = []
  include Aws::Structure
end

#web_acl_arn ⇒ String

The ARN of the WebAcl associated with the Stage.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 5009

class Stage < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :access_log_settings,
  :canary_settings,
  :tracing_enabled,
  :web_acl_arn,
  :tags,
  :created_date,
  :last_updated_date)
  SENSITIVE = []
  include Aws::Structure
end