Class: Aws::ApiGatewayV2::Types::Stage

Inherits:

Struct

• Object
• Struct
• Aws::ApiGatewayV2::Types::Stage

Defined in:

gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb

Overview

Represents an API stage.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #access_log_settings ⇒ Types::AccessLogSettings

  Settings for logging access in this stage.

• #api_gateway_managed ⇒ Boolean

  Specifies whether a stage is managed by API Gateway.

• #auto_deploy ⇒ Boolean

  Specifies whether updates to an API automatically trigger a new deployment.

• #client_certificate_id ⇒ String

  The identifier of a client certificate for a Stage.

• #created_date ⇒ Time

  The timestamp when the stage was created.

• #default_route_settings ⇒ Types::RouteSettings

  Default route settings for the stage.

• #deployment_id ⇒ String

  The identifier of the Deployment that the Stage is associated with.

• #description ⇒ String

  The description of the stage.

• #last_deployment_status_message ⇒ String

  Describes the status of the last deployment of a stage.

• #last_updated_date ⇒ Time

  The timestamp when the stage was last updated.

• #route_settings ⇒ Hash<String,Types::RouteSettings>

  Route settings for the stage, by routeKey.

• #stage_name ⇒ String

  The name of the stage.

• #stage_variables ⇒ Hash<String,String>

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

• #tags ⇒ Hash<String,String>

  The collection of tags.

Instance Attribute Details

#access_log_settings ⇒ Types::AccessLogSettings

Settings for logging access in this stage.

Returns:

• (Types::AccessLogSettings)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5611

class Stage < Struct.new(
  :access_log_settings,
  :api_gateway_managed,
  :auto_deploy,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_deployment_status_message,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#api_gateway_managed ⇒ Boolean

Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.

Returns:

• (Boolean)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5611

class Stage < Struct.new(
  :access_log_settings,
  :api_gateway_managed,
  :auto_deploy,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_deployment_status_message,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#auto_deploy ⇒ Boolean

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

Returns:

• (Boolean)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5611

class Stage < Struct.new(
  :access_log_settings,
  :api_gateway_managed,
  :auto_deploy,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_deployment_status_message,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#client_certificate_id ⇒ String

The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

Returns:

• (String)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5611

class Stage < Struct.new(
  :access_log_settings,
  :api_gateway_managed,
  :auto_deploy,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_deployment_status_message,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#created_date ⇒ Time

The timestamp when the stage was created.

Returns:

• (Time)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5611

class Stage < Struct.new(
  :access_log_settings,
  :api_gateway_managed,
  :auto_deploy,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_deployment_status_message,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#default_route_settings ⇒ Types::RouteSettings

Default route settings for the stage.

Returns:

• (Types::RouteSettings)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5611

class Stage < Struct.new(
  :access_log_settings,
  :api_gateway_managed,
  :auto_deploy,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_deployment_status_message,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_id ⇒ String

The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

Returns:

• (String)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5611

class Stage < Struct.new(
  :access_log_settings,
  :api_gateway_managed,
  :auto_deploy,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_deployment_status_message,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the stage.

Returns:

• (String)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5611

class Stage < Struct.new(
  :access_log_settings,
  :api_gateway_managed,
  :auto_deploy,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_deployment_status_message,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#last_deployment_status_message ⇒ String

Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

Returns:

• (String)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5611

class Stage < Struct.new(
  :access_log_settings,
  :api_gateway_managed,
  :auto_deploy,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_deployment_status_message,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_date ⇒ Time

The timestamp when the stage was last updated.

Returns:

• (Time)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5611

class Stage < Struct.new(
  :access_log_settings,
  :api_gateway_managed,
  :auto_deploy,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_deployment_status_message,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#route_settings ⇒ Hash<String,Types::RouteSettings>

Route settings for the stage, by routeKey.

Returns:

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

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5611

class Stage < Struct.new(
  :access_log_settings,
  :api_gateway_managed,
  :auto_deploy,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_deployment_status_message,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#stage_name ⇒ String

The name of the stage.

Returns:

• (String)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5611

class Stage < Struct.new(
  :access_log_settings,
  :api_gateway_managed,
  :auto_deploy,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_deployment_status_message,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#stage_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 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5611

class Stage < Struct.new(
  :access_log_settings,
  :api_gateway_managed,
  :auto_deploy,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_deployment_status_message,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  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 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5611

class Stage < Struct.new(
  :access_log_settings,
  :api_gateway_managed,
  :auto_deploy,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_deployment_status_message,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end