You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Represents an API stage.

Instance Attribute Summary collapse

Instance Attribute Details

#access_log_settingsTypes::AccessLogSettings

Settings for logging access in this stage.

Returns:

#api_gateway_managedBoolean

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)

    Specifies whether a stage is managed by API Gateway.

#auto_deployBoolean

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

Returns:

  • (Boolean)

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

#client_certificate_idString

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

Returns:

  • (String)

    The identifier of a client certificate for a Stage.

#created_dateTime

The timestamp when the stage was created.

Returns:

  • (Time)

    The timestamp when the stage was created.

#default_route_settingsTypes::RouteSettings

Default route settings for the stage.

Returns:

#deployment_idString

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

Returns:

  • (String)

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

#descriptionString

The description of the stage.

Returns:

  • (String)

    The description of the stage.

#last_deployment_status_messageString

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

Returns:

  • (String)

    Describes the status of the last deployment of a stage.

#last_updated_dateTime

The timestamp when the stage was last updated.

Returns:

  • (Time)

    The timestamp when the stage was last updated.

#route_settingsHash<String,Types::RouteSettings>

Route settings for the stage, by routeKey.

Returns:

#stage_nameString

The name of the stage.

Returns:

  • (String)

    The name of the stage.

#stage_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-._~:/?#&=,]+. Supported only for WebSocket APIs.

Returns:

  • (Hash<String,String>)

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

#tagsHash<String,String>

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

Returns:

  • (Hash<String,String>)

    The collection of tags.